{"openapi":"3.0.0","info":{"title":"Rooms Master API","description":"The Zoom Rooms REST APIs allow you to manage your Zoom Rooms.  For example, you can create new Zoom Rooms, read their current configuration, or make configuration changes.  The Zoom Rooms REST API for [Zoom Room Controls](https://developers.zoom.us/docs/zoom-rooms/)in particular allows you to perform limited active control of a Zoom Room, such as starting or leaving a meeting, changing the mute state, or restarting the Zoom Room, among other capabilities.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/accounts/{accountId}/rooms":{"get":{"tags":["Zoom Rooms"],"summary":"List Zoom Rooms","description":"Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in a Zoom account.  \n   \n \n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_rooms:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"listZoomRooms","parameters":[{"name":"status","in":"query","description":"The status of the Zoom Room.","required":false,"style":"form","schema":{"type":"string","example":"Offline","enum":["Offline","Available","InMeeting","UnderConstruction"]}},{"name":"tag_ids","in":"query","description":"The room tag IDs associated with the Zoom Room. Use commas (,) to separate between them. It's 'OR' logic if query for multiple tags.","required":false,"style":"form","schema":{"type":"string","example":"90bdda6c226f4f10a4b9a34be8d69f30,12345a6c226f4f10a4b9a34be8d69f30"}},{"name":"type","in":"query","description":"The type of Zoom Rooms .","required":false,"style":"form","schema":{"type":"string","example":"ZoomRoom","enum":["Kiosk","ZoomRoom","StandaloneWhiteboard","SchedulingDisplayOnly","DigitalSignageOnly","PersonalZoomRoom"]}},{"name":"unassigned_rooms","in":"query","description":"Use this query parameter with a value of `true` if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.","required":false,"style":"form","schema":{"type":"boolean","example":true,"default":false}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"style":"form","schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"location_id","in":"query","description":"The parent location ID of the Zoom Room.","required":false,"style":"form","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"query_name","in":"query","description":"The name of a Zoom Room. If you do not call this parameter, the API will return all of the account's Zoom Rooms.","required":false,"style":"form","schema":{"type":"string","example":"My Zoom Room name"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nA list of Zoom Rooms returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":20},"rooms":{"type":"array","description":"List of existing Zoom Rooms.","items":{"type":"object","properties":{"activation_code":{"type":"string","description":"The code used to complete the setup of the Zoom Room.","example":"1315-2376-2198-7926"},"id":{"type":"string","description":"The Zoom Room ID.","example":"qMOLddnySIGGVycz8aX_JQ"},"location_id":{"type":"string","description":"Unique Identifier of the [location](/docs/api-reference/zoom-api/methods#operation/listZRLocations) of the room.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"name":{"type":"string","description":"Name of the Zoom Room.","example":"My Personal Meeting Room"},"room_id":{"type":"string","description":"The Zoom Room ID. Use this ID for the **Dashboard Zoom Room APIs**.","example":"qMOLddnySIGGVycz8aX_JQ"},"status":{"type":"string","description":"Status of the Zoom Room.","example":"Offline","enum":["Offline","Available","InMeeting","UnderConstruction"]},"tag_ids":{"type":"array","description":"The list of room tag ID associated with the Zoom Room.","items":{"type":"string","description":"The room tag ID associated with the Zoom Room.","example":"90bdda6c226f4f10a4b9a34be8d69f30"}}}}}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:list_rooms:master"]}},"post":{"tags":["Zoom Rooms"],"summary":"Add a Zoom Room","description":"Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.  \n   \n \n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"addARoom","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["name","type"],"type":"object","properties":{"location_id":{"type":"string","description":"**Optional**  \n Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as &ldquo;country, states, city, campus, building, floor&rdquo;, a room can only be added under the floor level location. \n\nThis ID can be retrieved from the [**List Zoom Room locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"name":{"type":"string","description":"Name of the Zoom Room.","example":"My Personal Meeting Room"},"type":{"type":"string","description":"Type of the Zoom Room. ","example":"ZoomRoom","enum":["Kiosk","ZoomRoom","StandaloneWhiteboard","SchedulingDisplayOnly","DigitalSignageOnly","PersonalZoomRoom"]},"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"u7GQ3q_zQbqJnNp02-oMjQ"},"tag_ids":{"type":"array","description":"The tag IDs that will be associated with the Zoom Room.","example":["90bdda6c226f4f10a4b9a34be8d69f30","1234ds6c226f4f10a4b9a34be8d69f30"],"items":{"type":"string","description":"Unique UUID that identifies the room tag.","example":"90bdda6c226f4f10a4b9a34be8d69f30"}},"user_id":{"type":"string","description":"The user ID of the user assigned to a Personal Zoom Room.  Note: this field will only be accepted when the zoom_room_type is PersonalZoomRoom.","example":"Ih3wZpAjTlitZcAhuYRbxg"},"pro_device":{"type":"boolean","description":"If enabled, the Personal Zoom Room will consume a Zoom Rooms license and have access to \"Pro\" features.  Note: this field will only be present for Personal Zoom Rooms.","example":true}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` **Created**  \n \nZoom Room added successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The Zoom Room ID.","example":"qMOLddnySIGGVycz8aX_JQ"},"location_id":{"type":"string","description":"Location ID of the location where the Zoom Room was added.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"name":{"type":"string","description":"Name of the Zoom Room.","example":"My Personal Meeting Room"},"room_id":{"type":"string","description":"The Zoom Room ID. Use this ID for the **Dashboard Zoom Room APIs**.","example":"qMOLddnySIGGVycz8aX_JQ"},"tags":{"type":"array","description":"The room tags associated with this Zoom Room.","items":{"type":"object","properties":{"tag_name":{"type":"string","description":"The tag name associated with this Zoom Room.","example":"private room"},"tag_id":{"type":"string","description":"The room tag ID associated with the Zoom Room.","example":"90bdda6c226f4f10a4b9a34be8d69f30"}},"description":"room tag name"}},"type":{"type":"string","description":"Type of the Zoom Room.","example":"ZoomRoom","enum":["Kiosk","ZoomRoom","StandaloneWhiteboard","SchedulingDisplayOnly","DigitalSignageOnly","PersonalZoomRoom"]},"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"u7GQ3q_zQbqJnNp02-oMjQ"},"user_id":{"type":"string","description":"The user ID of the user assigned to a Personal Zoom Room.  Note: this field will only be accepted when the zoom_room_type is PersonalZoomRoom.","example":"Ih3wZpAjTlitZcAhuYRbxg"},"pro_device":{"type":"boolean","description":"If enabled, the Personal Zoom Room will consume a Zoom Rooms license and have access to \"Pro\" features.  Note: this field will only be present for Personal Zoom Rooms.","example":true}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAt least one normal Zoom Rooms required.<br><br> <br>\n**Error Code:** `300` <br>\n Invalid parent location ID: {location_id}.<br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4801` <br>\n Location not found: {location_id}.<br><br>. <br>\n**Error Code:** `4060` <br>\n Calendar resource does not exist: {resourceId}.<br><br> <br>\n**Error Code:** `8306` <br>\n Tag ID does not exist: [{tagId1}, {tagId2}]. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:room:master"]}}},"/accounts/{accountId}/rooms/configuration_profiles/{profileId}/apply":{"post":{"tags":["Zoom Rooms"],"summary":"Apply configuration profile for Zoom Rooms","description":"Apply a configuration profile for Zoom Rooms.\n\n**Prerequisites**  \n \n* Pro or a higher plan with [Zoom Rooms](https://zoom.us/zoomrooms) license\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"ApplyconfigurationprofileforZoomRoom","parameters":[{"name":"profileId","in":"path","description":"The unique identifier of the configuration profile.","required":true,"style":"simple","schema":{"type":"string","example":"007ec03d-7110-4366-8027-c7d28fd20a4c"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"room_ids":{"type":"array","description":"An array of Zoom Room IDs (maximum 100 Zoom Rooms supported).","items":{"type":"string","description":"The Zoom Room ID.","example":"[\"G8GQaE9FR_SGExBTUC5Cew\",\"qMOLddnySIGGVycz8aX_JQ\"]"}}}}}}},"responses":{"202":{"description":"**HTTP Status Code:** `202` **Accepted**\n\nConfiguration profile applied for Zoom Rooms successfully. Check the task results in the web portal using the task ID.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"The unique identifier of the apply operation.","example":"96e8f337-82cd-4fee-9169-64fc90e3bcef"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300520001` <br>\n Invalid parameters. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:room_settings:master"]}}},"/accounts/{accountId}/rooms/digital_signage":{"get":{"tags":["Zoom Rooms"],"summary":"List digital signage contents","description":"Use this API to return information about a Zoom account's [Zoom Rooms digital signage content](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage). You can also view this content in the **Room Management** section's [**Digital Signage Content**](https://zoom.us/digitalsignage#/) tab in the Zoom web portal. \n\n**Prerequisites:** \n* A Pro or a higher account with Zoom Rooms. \n* Existing content in the **Digital Signage Content** tab.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`","operationId":"listDigitalSignageContent","parameters":[{"name":"type","in":"query","description":"Specify the type of digital signage resource. The value can be one of the following:\n* `content`: Returns information about content files.\n* `folder`: Returns information about the folder where the content files are located.","required":false,"style":"form","schema":{"type":"string","example":"content"}},{"name":"folder_id","in":"query","description":"Unique identifier of the folder where the content is located. Provide this field if you would like to filter the response by contents that are only available in a specific folder.","required":false,"style":"form","schema":{"type":"string","example":"LHMmOOYaRiOA5m5WZjXVPA"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"style":"form","schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nList returned.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the content or the folder. ","example":"LHMmOOYaRiOA5m5WZjXVPA"},"name":{"type":"string","description":"Name of the content file or the folder.","example":"content name"}}}},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":20}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["room:master"]}}},"/accounts/{accountId}/rooms/events":{"patch":{"tags":["Zoom Rooms"],"summary":"Update E911 digital signage","description":"Display or hide E911 emergency alert text content from [Zoom Rooms digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage).\n\n**Prerequisites:**  \n \n* [Zoom Rooms](https://zoom.us/zoomrooms/software) 5.3.0 or higher\n* Zoom Rooms digital signage must be [enabled](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-Digital-Signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd)\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_controls:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"manageE911signage","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","description":"To display the emergency content on the Zoom Rooms digital signage display, set the value of this field to be `zoomroom.emergency_alert_displayed`.","example":"zoomroom.emergency_alert_displayed","enum":["zoomroom.emergency_alert_displayed"]},"params":{"type":"object","properties":{"content":{"type":"string","description":"The content to display. The `content` and `head` cannot both be null.","example":"display content"},"target_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Provide one of the following IDs associated with the Zoom Room.  \n \n\n* `accountId`: Account ID of the Zoom account.  \n  Provide account ID as the value of this field to display the alert content on all Zoom Rooms' displays in the account.  \n   \n \n* `locationId`: Location ID. Get the value of this field by calling the [**List Zoom Rooms locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API. \n Provide location ID as the value of this field to display the alert content on all Zoom Rooms' displays listed in the specified location.  \n   \n \n* `roomId`: the Zoom Room ID. Get the value of this field by calling the [**List Zoom Rooms**](/docs/api-reference/zoom-api/methods#operation/listZoomRooms) API. Provide room ID as the value of this field to display the alert content on a specific Zoom Rooms' display.","items":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},"target_type":{"type":"string","description":"Provide one of the following values for this field that is associated to the value you entered in the `target_ids` field.   \n \n* `account`\n* `location`\n* `room`","example":"account","enum":["account","location","room"]},"head":{"type":"string","description":"The head to display. The `head` and `content` cannot both be null.","example":"display head"},"style":{"type":"object","properties":{"background_color":{"type":"string","description":"The background color.","example":"red","default":"red","enum":["red","orange","blue","green"]}},"description":"The background color style."}}}},"description":"Provide this request body to set and display the emergency alert content. "},{"type":"object","properties":{"method":{"type":"string","description":"To remove the emergency content from the Zoom Rooms digital signage display, set the value of this field to be `zoomroom.emergency_alert_removed`.","example":"zoomroom.emergency_alert_removed","enum":["zoomroom.emergency_alert_removed"]},"params":{"type":"object","properties":{"event_id":{"type":"string","description":"Unique identifier of the event. ","example":"qjou65kp9q2q6vdg73jqk540hg"},"target_ids":{"maxItems":10,"minItems":1,"type":"array","description":"Provide one of the following IDs associated with the Zoom Room.  \n \n\n* `accountId`: Account ID of the Zoom account.  \n  Provide account ID as the value of this field to remove the alert content from all Zoom Rooms' displays in the account.  \n   \n \n* `locationId`: Location ID. Get the value of this field by calling the [**List Zoom Rooms locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API. \n Provide location ID as the value of this field to remove the alert content from all Zoom Rooms' displays listed in the specified location.  \n   \n \n* `roomId`: the Zoom Room ID. Get the value of this field by calling the [**List Zoom Rooms**](/docs/api-reference/zoom-api/methods#operation/listZoomRooms) API. Provide room ID as the value of this field to remove the alert content from a specific Zoom Rooms' display.","items":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},"target_type":{"type":"string","description":"Provide one of the following values for this field that is associated to the value you entered in the `target_ids` field.   \n \n* `account`\n* `location`\n* `room`","example":"account","enum":["account","location","room"]},"force_remove":{"type":"boolean","description":"If set to true, the Zoom Room, Location or Account will remove the current emergency alert message, even if the corresponding event_id is not supplied.","example":false}}}},"description":"Provide this request body to remove the emergency alert content. Note that there won't be a response body for this request."}]}}}},"responses":{"202":{"description":"**HTTP Status Code:** `202`  **Accepted**  \n \nList processed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n Event id is required.<br>\nInvalid value submitted for Target Ids. Provide a valid Target Id associated with the Target type. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `200` <br>\n Access restricted. <br><br> <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:room_controls:master"]}}},"/accounts/{accountId}/rooms/{id}/events":{"patch":{"tags":["Zoom Rooms"],"summary":"Use Zoom Room controls","description":"Controls [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343), including: \n* Room check-in and check-out.\n* Video and audio mute on and off.\n* Incoming meeting request accept or decline.\n* Meeting join, leave, or end.\n* Room restart.\n* Cancellation.\n* Switch between available cameras, speakers or microphones during a meeting.\n* Start or stop screen sharing.\n* Perform speaker volume changes during a meeting.\n\n\n\n**Prerequisites:**\n* [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-started-with-Zoom-Rooms#:~:text=Zoom%20Rooms%20is%20a%20software,or%20from%20their%20mobile%20device) must have been set up for use for the account and must be online. \n* You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the room.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_control:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"ZoomRoomsControls","parameters":[{"name":"id","in":"path","description":"The room ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"The Zoom Rooms check-in feature that helps maximize your room utilization. This API can either **check in** and confirm that you are using the room reservation or **check out** of the room so that the room is released from the scheduled meeting and made available for others to use.","example":"zoomroom.check_in","enum":["zoomroom.check_in"]},"params":{"type":"object","properties":{"calendar_id":{"type":"string","description":"The `id` field included in the [`calendarList` resource](https://developers.google.com/calendar/v3/reference/calendarList#resource). This field is only required if using Google Calendar for the event associated with the Zoom Room. Retrieve the value for this field by calling Google's [`CalendarList:list` API](https://developers.google.com/calendar/v3/reference/events/list). Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"mycalendar@example.com"},"change_key":{"type":"string","description":"Represent the specific version of the calendar item. Retrieve it using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). It refers to the `ChangeKey` field of the `ItemId` element included in the operation response. This field is required only for Microsoft Exchange or Office 365 calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"test_change_key"},"event_id":{"type":"string","description":"**Required** The unique identifier of the calendar event associated with the Zoom Room.\n\n If using Microsoft Exchange for the calendar integration, retrieve the value of this field using Microsoft's [`FindItem` Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The value is the `Id` field of the `ItemId` element included in the operation response.\n\n If using the Google calendar integration for this event, call Google's [`Events:list` API](https://developers.google.com/calendar/v3/reference/events/list) to retrieve the value. The value is the `id` field in the [events resource](https://developers.google.com/calendar/v3/reference/events#resource). Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"ebrg2b87a6uu9c678qhvsiahsc"},"resource_email":{"type":"string","description":"The [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365) associated with the calendar. This field is only required for Microsoft Exchange / Office 365 Calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`.","format":"email","example":"zroom1@example.com"}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either **check in** and confirm that you are utilizing the room reservation or to **check out** of the room so that the room is released from the scheduled meeting and made available for others to use.","example":"zoomroom.check_out","enum":["zoomroom.check_out"]},"params":{"type":"object","properties":{"calendar_id":{"type":"string","description":"The `id` field included in the [calendarList resource](https://developers.google.com/calendar/v3/reference/calendarList#resource). This field is only required if Google Calendar is being used for the event associated with the Zoom Room. The value for this field can be retrieved by calling Google's [CalendarList:list API](https://developers.google.com/calendar/v3/reference/events/list). Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"mycalendar@example.com"},"change_key":{"type":"string","description":"Represents the specific version of the calendar item. Retrieve it using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). It refers to the `ChangeKey` field of the `ItemId` element included in the operation response. This field is required only for Microsoft Exchange or Office 365 calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"test_change_key"},"event_id":{"type":"string","description":"**Required** The unique identifier of the calendar event associated with the Zoom Room.\n\n If using Microsoft Exchange for the calendar integration, retrieve the value of this field using Microsoft's [FindItem Operation](https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/finditem-operation). The value is the `Id` field of the `ItemId` element included in the operation response.\n\n If using the Google calendar integration for this event, call Google's [Events:list API](https://developers.google.com/calendar/v3/reference/events/list) to retrieve the value. The value is the `id` field in the [events resource](https://developers.google.com/calendar/v3/reference/events#resource). Applies to `zoomroom.check_in` and `zoomroom.check_out`.","example":"ebrg2b87a6uu9c678qhvsiahsc"},"resource_email":{"type":"string","description":"The [resource mailbox](https://support.microsoft.com/en-us/help/10063/creating-and-managing-resource-mailboxes-in-office-365) associated with the calendar. This field is only required for Microsoft Exchange / Office 365 Calendar. Applies to `zoomroom.check_in` and `zoomroom.check_out`.","format":"email","example":"zroom1@example.com"}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Mute the Zoom Rooms client.","example":"zoomroom.mute","enum":["zoomroom.mute"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Unmute the Zoom Rooms client.","example":"zoomroom.unmute","enum":["zoomroom.unmute"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Accept a meeting through the Zoom Rooms client.","example":"zoomroom.meeting_accept","enum":["zoomroom.meeting_accept"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Decline a meeting through the Zoom Rooms client.","example":"zoomroom.meeting_decline","enum":["zoomroom.meeting_decline"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Restart the Zoom Room client.","example":"zoomroom.restart","enum":["zoomroom.restart"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Leave a meeting in progress through the Zoom Rooms client.","example":"zoomroom.meeting_leave","enum":["zoomroom.meeting_leave"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Join a Zoom meeting from the Zoom Rooms client.","example":"zoomroom.meeting_join","enum":["zoomroom.meeting_join"]},"params":{"type":"object","properties":{"meeting_number":{"type":"string","description":"**Required** The meeting number. If this field has a value, join the meeting identified by this number. If this field does not have a value, start an [instant meeting](https://support.zoom.us/hc/en-us/articles/201362533-Instant-meetings-vs-scheduled-meetings). Applies to `zoomroom.meeting_join`.","example":"2022052323"},"passcode":{"type":"string","description":"The passcode to join the meeting.","example":"A123456"},"force_accept":{"type":"boolean","description":"Whether to force a user to immediately join the meeting. If true, forces the user to leave any current meetings and immediately join the meeting passed in the `meeting_number` value (or instant meeting, if there is no value). ","example":false},"make_zoom_room_host":{"type":"boolean","description":"Default: false.  If set to true, the Zoom Room will join this single meeting with the host role, if it joins before the meeting host and other participants, equivalent to the Zoom Rooms configuration setting [Make Zoom Rooms the host if it joins before meeting host and other participants](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060489)","example":false}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Invite a contact to use the Zoom Rooms client.","example":"zoomroom.meeting_invite","enum":["zoomroom.meeting_invite"]},"params":{"type":"object","properties":{"user_ids":{"type":"array","description":"(Required) A comma-separated list of callee user IDs, up to a maximum of 10 callees.","example":["30R7kT7bTIKSNUFEuH_Qlg"],"items":{"type":"string","description":"The user ID.","example":"30R7kT7bTIKSNUFEuH_Qlg"}}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Cancel a meeting via the Zoom Rooms client.","example":"zoomroom.meeting_cancel","enum":["zoomroom.meeting_cancel"]},"params":{"type":"object","properties":{"meeting_topic":{"type":"string","description":"**Required** The meeting topic, up to 200 characters.","example":"My zoom topic"},"start_time":{"type":"string","description":"**Required** The meeting's start time in ISO date-time format. If you use this value with the timezone, you must also pass the timezone field.","example":"2022-05-20T12:00:00Z"},"duration":{"type":"integer","description":"The scheduled meeting duration in minutes.","example":60},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones). Optional if the `start_time` value includes a timezone offset. Applies to `zoomroom.meeting_cancel` and `zoomroom.meeting_schedule`.","example":"America/Los_Angeles"}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"End a meeting in progress hosted by the Zoom Rooms client.","example":"zoomroom.meeting_end","enum":["zoomroom.meeting_end"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Schedule a meeting using the Zoom Rooms client.","example":"zoomroom.meeting_schedule","enum":["zoomroom.meeting_schedule"]},"params":{"type":"object","properties":{"passcode":{"type":"string","description":"The passcode to join the meeting.","example":"A123456"},"meeting_topic":{"type":"string","description":"**Required** The meeting topic, up to 200 characters.","example":"My zoom topic"},"start_time":{"type":"string","description":"**Required** The meeting's start time in ISO date-time format. If you use this value with the timezone, you must also pass the timezone field.","example":"2022-05-20T12:00:00Z"},"duration":{"type":"integer","description":"The scheduled meeting duration in minutes. Required for `zoomroom.meeting_cancel` and `zoomroom.meeting_schedule`.","example":60},"timezone":{"type":"string","description":"The meeting's [timezone](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones). Optional if the `start_time` value includes a timezone offset.","example":"America/Los_Angeles"},"settings":{"type":"object","properties":{"join_before_host":{"type":"boolean","description":"Whether to allow meeting participants to join before the meeting's host. Used only for scheduled or recurring meetings.","example":false}},"description":"The meeting settings. Applies to`zoomroom.meeting_schedule`."}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Join a third-party meeting.","example":"zoomroom.thirdparty_meeting_join","enum":["zoomroom.thirdparty_meeting_join"]},"params":{"type":"object","properties":{"event_id":{"type":"string","description":"The event ID of the event to be started.  Join the meeting through the event in the calendar. It is required for schedule meeting, but not for ad hoc meetings.  When using this field, other fields will all default to null.","example":"ebrg2b87a6uu9c678qhvsiahsc"},"passcode":{"type":"string","description":"The passcode for joining a third-party meeting. This field is not mandatory, it can be filled in when the meeting really has a passcode. It is required when join_type is meeting_id, and meeting_source_type is MS_TEAMS.","example":"A123456"},"join_type":{"type":"string","description":"The specific method of joining a conference. This field is only applicable to ad hoc conferences and is required. \n* `url` &mdash; Joining a meeting through the Teams/Meet joining URL.\n* `meeting_id` &mdash; Joining the meeting through the meeting ID and passcode of MS_TEAMS/GOOGLE_MEET.","example":"url","enum":["url","meeting_id","sip"]},"meeting_source_type":{"type":"string","description":"The type of third-party meeting that is specifically joined. Only required when `join_type` is `url` or `meeting_id`. \n* `MS_TEAMS` &mdash; MS teams meeting. \n*  `GOOGLE_MEET` &mdash; Google Meet meeting. ","example":"MS_TEAMS","enum":["MS_TEAMS","GOOGLE_MEET"]},"join_url":{"type":"string","description":"The URL for joining a Teams/Meet meeting. It needs to be filled only when `join_type` is url, and `meeting_source_type` is MS_TEAMS/GOOGLE_MEET.","example":"url"},"sip_address":{"type":"string","description":"The full SIP address to join the third-party meeting. If the SIP conference has a passcode, the passcode must be spliced according to the rules of the SIP provider. It is required only when `join_type` is `sip`.","example":"sip url"},"third_party_meeting_id":{"type":"string","description":"The meeting id of the third-party meeting. It is required only when `join_type` is `meeting_id`, and `meeting_source_type` is `MS_TEAMS`/`GOOGLE_MEET`.","example":"12324423"}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Start a Zoom Room alert.","example":"zoomroom.alarm_start","enum":["zoomroom.alarm_start"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Stop a Zoom Room alert.","example":"zoomroom.alarm_stop","enum":["zoomroom.alarm_stop"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Mute the Zoom Rooms client's camera(s).","example":"zoomroom.video_mute","enum":["zoomroom.video_mute"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Unmute the Zoom Rooms client's camera(s).","example":"zoomroom.video_unmute","enum":["zoomroom.video_unmute"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Switch the camera used by the Zoom Rooms client during a meeting.  This API has no effect if the Zoom Rooms client is not in a meeting.","example":"zoomroom.switch_camera","enum":["zoomroom.switch_camera"]},"params":{"type":"object","properties":{"cameraId":{"type":"string","description":"**Required** The new camera ID for the Zoom Rooms client to use.  Retrieve [Zoom Room device information](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRDevices) to find the available camera device IDs. This API has no effect if an invalid device ID is specified.","example":"{0.0.1.00000000}.{eff76542-ac52-4c78-bd90-67f968bab16f}"}},"example":""}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Switch the microphone used by the Zoom Rooms client during a meeting.  This API has no effect if the Zoom Rooms client is not in a meeting.","example":"zoomroom.switch_microphone","enum":["zoomroom.switch_microphone"]},"params":{"type":"object","properties":{"microphoneId":{"type":"string","description":"**Required** The new microphone ID for the Zoom Rooms client to use.  Retrieve [Zoom Room device information](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRDevices) to find the available microphone device IDs.  This API has no effect if an invalid device ID is specified.","example":"{0.0.1.00000000}.{eff76542-ac52-4c78-bd90-67f968bab16f}"}},"example":"microphoneId"}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Switch the speaker used by the Zoom Rooms client during a meeting.  This API has no effect if the Zoom Rooms client is not in a meeting.","example":"zoomroom.switch_speaker","enum":["zoomroom.switch_speaker"]},"params":{"type":"object","properties":{"speakerId":{"type":"string","description":"**Required** The new speaker ID for the Zoom Rooms client to use.  Retrieve [Zoom Room device information](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRDevices) to find the available speaker device IDs.  This API has no effect if an invalid device ID is specified.","example":"{0.0.1.00000000}.{eff76542-ac52-4c78-bd90-67f968bab16f}"}}}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Start sharing content on the Zoom Rooms client.","example":"zoomroom.share_content_start","enum":["zoomroom.share_content_start"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Stop sharing content on the Zoom Rooms client.","example":"zoomroom.share_content_stop","enum":["zoomroom.share_content_stop"]}}},{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Change the speaker volume of the Zoom Rooms client.  This API has no effect if used when the Zoom Room is not in a meeting.","example":"zoomroom.volume_level","enum":["zoomroom.volume_level"]},"params":{"type":"object","properties":{"volume_level":{"type":"integer","description":"**Required** The new speaker volume level for the Zoom Rooms client to use.  Acceptable values range from 0-100.  This API has no effect if an invalid device ID is specified.","example":0}}}}}]}}}},"responses":{"202":{"description":"**HTTP Status Code:** `202` **Accepted**  \n \nRequest processed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n * Zoom Room is offline. Please ensure that the Zoom Room is online before checking in or checking out. *Invalid parameters.* Device does not exist: {cameraId or speakerId or microphoneId}. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:room_control:master"]}}},"/accounts/{accountId}/rooms/{id}/settings":{"get":{"tags":["Zoom Rooms"],"summary":"Get Zoom Room settings","description":"Get information on meeting, alert, digital signage or scheduling display settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.   \n**Prerequisites:**   *Zoom Room licenses* Owner or Admin privileges on the Zoom Account.   \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:room_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRSettings","parameters":[{"name":"id","in":"path","description":"Unique Identifier of the Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"setting_type","in":"query","description":"The type of setting that you would like to retrieve.\n\n`alert`: Alert settings of the Zoom Room.\n\n`meeting`: Meeting settings of the Zoom Room.\n\n`signage`: Digital Signage settings of the Zoom Room.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Room.","required":true,"style":"form","schema":{"type":"string","example":"meeting","default":"meeting"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Room settings returned successfully.","content":{"application/json":{"schema":{"oneOf":[{"title":"index0","type":"object","properties":{"meeting_security":{"type":"object","properties":{"encryption_type":{"type":"string","description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**.   \n   \n The value of this field can be one of the following:  \n \n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Allow use of end-to-end encryption for meetings. If set to `true`, you can specify the encryption type in `encryption_type` field.","example":true},"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with one security option. Require that all meetings are secured with one of the following security options: a passcode, Waiting Room, or &quot;Only authenticated users can join meetings&quot;. If no security option is enabled, Zoom will secure all meetings with Waiting Room.","example":true},"waiting_room":{"type":"boolean","description":"When participants join a meeting, place them in a waiting room and require the host to admit them individually. Enabling the waiting room automatically disables the setting for allowing participants to join before host.","example":true},"meeting_password":{"type":"boolean","description":"A passcode will be generated when scheduling a meeting and participants require the passcode to join the meeting. The Personal Meeting ID (PMI) meetings are not included.","example":true},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Require a passcode for meetings which have already been scheduled","example":true},"rmi_password":{"type":"boolean","description":"All Room Meeting ID meetings that users can join via client, or room systems will be passcode-protected.","example":true},"password_for_rmi":{"type":"string","description":"A passcode will be generated when joining a room meeting with  Room Personal Meeting ID. ","example":"true"},"phone_password":{"type":"boolean","description":"A numeric passcode will be required for participants joining by phone if your meeting has a passcode. For meeting with an alphanumeric passcode, a numeric version will be generated.","example":true}}},"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"remote_support":{"type":"boolean","description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`. By enabling this setting, the setting `allow_multiple_content_sharing` will not work.","example":true,"default":false},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"hide_share_instruction":{"type":"boolean","description":"Hide share instructions from TV.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"make_room_alternative_host":{"type":"boolean","description":"If enabled, a Zoom Room automatically becomes the host when it joins an internal meeting before the host and other participants.","example":true},"hide_user_personal_information":{"type":"boolean","description":"If enabled, all personal information in contact details page will be hidden.","example":true},"bypass_meeting_password":{"type":"boolean","description":"If enabled, users do not need to manually enter the meeting passcode when a Zoom Room joins a scheduled meeting on its meeting list. ","example":true},"show_non_video_participants":{"type":"boolean","description":"If enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Rooms display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"start_airplay_mirroring":{"type":"boolean","description":"Allow users to share content via Apple Screen Mirroring (called Airplay on iOS 11 or earlier) in Zoom Rooms","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true},"entry_exit_chime":{"type":"string","description":"The sound that plays when participants join or leave a meeting: \n* `host` &mdash; Chime when host joins or leaves a meeting. \n* `all` &mdash; Chime when any participant joins or leaves a meeting. \n* `none` &mdash; Do not chime.","example":"all","enum":["host","all","none"]},"record_play_own_voice":{"type":"boolean","description":"When a participant joins by telephone, whether recording and playing the participant's own voice is enabled.","example":true},"incoming_meeting_request":{"type":"object","properties":{"automatically_accept_incoming_meeting_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming meeting requests (calls), such as being invited to a meeting in progress","example":true},"automatically_unmute":{"type":"boolean","description":"If enabled, the Zoom Room will automatically unmute after it automatically accepts the incoming meeting request and joins the meeting","example":true}}},"automatically_accept_far_end_camera_control_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming far end camera control (FECC) requests from other Zoom clients received during a Zoom meeting","example":true},"zr_always_display_name_label_in_meeting":{"type":"boolean","description":"When \"Always display participant name labels in meetings\" is enabled, participant name labels should be shown in all meetings (even in 1:1 meetings) attended by a Zoom Room.  When it is disabled, the current behavior should be preserved.","example":false}}}}},{"title":"index1","type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","description":"Display or hide banner room name.","example":true},"banner_sharing_key":{"type":"boolean","description":"Display or hide banner sharing key.","example":true},"banner_time":{"type":"boolean","description":"Display or hide time in the banner.","example":true}},"description":"Specifies the elements that you want to display in the top banner."},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. The value of this field indicates the duration in minutes.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. The value of this field indicates the duration in minutes.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Indicates whether digital signage is on or off,](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"standard"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"update","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"Duration for how long the content will be displayed.","example":65},"id":{"type":"string","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content.","example":"content name"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content list"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true},"zoom_room_calendar_resource_is_inaccessible":{"type":"boolean","description":"Send a notification when the calendar resource of a Zoom Room configured with calendar integration is inaccessible.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room not found:{roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:room_settings:master"]}},"patch":{"tags":["Zoom Rooms"],"summary":"Update Zoom Room settings","description":"Update meeting, alert, digital signage or scheduling display 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.   **Prerequisites:**   * Zoom Room licenses.* Owner or Admin privileges on the Zoom Account.   \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZRSettings","parameters":[{"name":"id","in":"path","description":"Unique Identifier of the Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"setting_type","in":"query","description":"The type of setting that you would like to update.\n\n`alert`: Alert settings of the Zoom Room.\n\n`meeting`: Meeting settings of the Zoom Room.\n\n`signage`: Digital Signage settings of the Zoom Room.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Room.","required":false,"style":"form","schema":{"type":"string","example":"alert"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"index0","type":"object","properties":{"meeting_security":{"type":"object","properties":{"encryption_type":{"type":"string","description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**.   \n   \n The value of this field can be one of the following:  \n \n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Allow use of end-to-end encryption for meetings. If set to `true`, you can specify the encryption type in `encryption_type` field.","example":true},"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with one security option. Require that all meetings are secured with one of the following security options: a passcode, Waiting Room, or &quot;Only authenticated users can join meetings&quot;. If no security option is enabled, Zoom will secure all meetings with Waiting Room.","example":true}}},"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"remote_support":{"type":"boolean","description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`. By enabling this setting, the setting `allow_multiple_content_sharing` will not work.","example":true,"default":false},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"hide_share_instruction":{"type":"boolean","description":"Hide share instructions from TV.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"make_room_alternative_host":{"type":"boolean","description":"If enabled, a Zoom Room automatically becomes the host when it joins an internal meeting before the host and other participants.","example":true},"hide_user_personal_information":{"type":"boolean","description":"If enabled, all personal information in contact details page will be hidden.","example":true},"bypass_meeting_password":{"type":"boolean","description":"If enabled, users do not need to manually enter the meeting passcode when a Zoom Room joins a scheduled meeting on its meeting list. ","example":true},"show_non_video_participants":{"type":"boolean","description":"If enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Room display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"start_airplay_mirroring":{"type":"boolean","description":"Allow users to share content via Apple Screen Mirroring (called Airplay on iOS 11 or earlier) in Zoom Rooms","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true},"entry_exit_chime":{"type":"string","description":"The sound that plays when participants join or leave a meeting: \n* `host` &mdash; Chime when host joins or leaves a meeting. \n* `all` &mdash; Chime when any participant joins or leaves a meeting. \n* `none` &mdash; Do not chime.","example":"all","enum":["host","all","none"]},"record_play_own_voice":{"type":"boolean","description":"When a participant joins by telephone, whether recording and playing the participant's own voice is enabled.","example":true},"incoming_meeting_request":{"type":"object","properties":{"automatically_accept_incoming_meeting_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming meeting requests (calls), such as being invited to a meeting in progress","example":true},"automatically_unmute":{"type":"boolean","description":"If enabled, the Zoom Room will automatically unmute after it automatically accepts the incoming meeting request and joins the meeting","example":true}}},"automatically_accept_far_end_camera_control_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming far end camera control (FECC) requests from other Zoom clients received during a Zoom meeting","example":true}}}}},{"title":"index1","type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","example":true},"banner_sharing_key":{"type":"boolean","example":true},"banner_time":{"type":"boolean","example":true}}},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. Specify the value of the duration in minutes in this field.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. Specify the value of duration in minutes in this field.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Enable or disable digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"standard"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"update","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content in the content list. The value can be one of the following:  \n \n`add`: Add another content to the content list.  \n \n`update`: Update existing content's information in the content list.  \n \n`delete`: Delete content from the content list.\n\n","example":"update"},"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"By default each content is display for 5 seconds. Using this field, specify how long you would like to display the content.","example":65},"id":{"type":"string","description":"Unique identifier of the content. This field is only required if you would like to remove or update the content information.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content.","example":"content name"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content list"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nSettings updated successfully. "},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:room_settings:master"]}}},"/accounts/{accountId}/rooms/{roomId}":{"get":{"tags":["Zoom Rooms"],"summary":"Get Zoom Room profile","description":"\nZoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.\n\n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRProfile","parameters":[{"name":"roomId","in":"path","description":"The unique identifier of the Zoom Room. This can be retrieved from the response of the [**List Zoom Rooms**](https://developers.zoom.us/docs/zoom-rooms/apis/#operation/listZoomRooms) API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"regenerate_activation_code","in":"query","description":"Whether to regenerate an activation code for a Zoom Room. Default is `false`.","required":false,"style":"form","schema":{"type":"boolean","example":true,"default":false}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Room profile returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"activation_code":{"type":"string","description":"The code used to complete the setup of the Zoom Room.","example":"1315-2376-2198-7926"},"hide_room_in_contacts":{"type":"boolean","description":"Whether to hide this Zoom Room from your contact list. **True** to hide.  **False** to show.","example":true},"name":{"type":"string","description":"Name of the Zoom Room.","example":"My Personal Meeting Room"},"display_name":{"maxLength":64,"type":"string","description":"The short display name of the Zoom Room.","example":"My Personal Meeting Room"},"required_code_to_ext":{"type":"boolean","description":"Determines whether to require a code to exit out of the Zoom Rooms application to switch between other apps.","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"The 1-16 digit number or characters used to secure your Zoom Rooms application. This code must be entered on your Zoom Room Controller to change settings or sign out.","example":"975193018"},"support_email":{"type":"string","description":"The email address to use for reporting Zoom Room issues.","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number to use for reporting Zoom Room issues.\n","example":"18798769876"},"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"u7GQ3q_zQbqJnNp02-oMjQ"},"zoom_room_type":{"type":"string","description":"The room type: `Kiosk`, `ZoomRoom`, `StandaloneWhiteboard`, `SchedulingDisplayOnly`, `DigitalSignageOnly`,`PersonalZoomRoom`","example":"ZoomRoom","enum":["Kiosk","ZoomRoom","StandaloneWhiteboard","SchedulingDisplayOnly","DigitalSignageOnly","PersonalZoomRoom"]},"location_id":{"type":"string","description":"The location ID of the place where the Zoom Room was added.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"tag_ids":{"type":"array","description":"The list of tag ID associated with the Zoom Room.","items":{"type":"string","description":"The  tag ID associated with the Zoom Room.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"}},"use_display_name_on_scheduling_display":{"type":"boolean","description":"If enabled, the Zoom Rooms Scheduling Display(s) of this Zoom Room will show the display_name instead of the name.  Note: this setting is only effective if a display_name is configured.","example":true},"use_display_name_on_zoom_rooms_display_and_controller":{"type":"boolean","description":"If enabled, the Zoom Rooms Controller(s) and Zoom Rooms display(s) of this Zoom Room will show the display_name instead of the name.  Note: this setting is only effective if a display_name is configured.","example":true},"use_display_name_in_meetings":{"type":"boolean","description":"If enabled, the Zoom Room will use the display_name instead of the name in meetings; the display_name will be shown in the Zoom meeting participants list and as the Zoom Rooms' label in the meeting video layout of other meeting participants.  Note: this setting is only effective if a display_name is configured and the use_on_zoom_rooms_and_controller setting is enabled.","example":true},"capacity":{"maximum":500,"minimum":1,"type":"number","description":"The in-room participant capacity of the Zoom Room.","example":1},"show_room_capacity_on_the_zoom_rooms":{"type":"boolean","description":"If enabled, the Zoom Room show the seating capacity the display(s) of the Zoom Room.  Note: this setting is only effective if a capacity is configured.","example":true},"show_room_capacity_on_the_scheduling_display":{"type":"boolean","description":"If enabled, the Zoom Room show the seating capacity the Zoom Rooms Scheduling Display(s) of the Zoom Room.  Note: this setting is only effective if a capacity is configured.","example":true},"user_id":{"type":"string","description":"The user ID of the user assigned to a Personal Zoom Room.  Note: this field will only be present for Personal Zoom Rooms.","example":"Ih3wZpAjTlitZcAhuYRbxg"}}},"device":{"type":"object","properties":{"device_profile_id":{"type":"string","description":"The device's profile ID.","example":"J352JVkNRpyAgUaurxmrsh"}},"description":"The information about the device."},"setup":{"type":"object","properties":{"checkin_and_checkout":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable check-in and check-out options.","example":true},"checkin_and_checkout_options":{"type":"object","properties":{"checkin_minutes_prior_to_meeting_start_time":{"type":"integer","description":"Allowed seconds for participants to check in prior to the meeting start time.","example":600},"allowed_minutes_before_release_room_after_no_checkout":{"type":"integer","description":"Allowed seconds before releasing a room due to no check-out or Zoom Room activity.","example":600},"enable_new_user_checkin_notification":{"type":"boolean","description":"Determine whether to notify in-room participants on the Zoom Rooms display when users check in.","example":true},"enable_remove_recurring":{"type":"boolean","description":"Remove recurring meeting series from Zoom Rooms.","example":true},"allowed_consecutive_missed_checkin_before_removing_room":{"type":"integer","description":"Allowed number of consecutive missed check-ins before removing the room from entire meeting series.","example":4}},"description":"Check-in and check-out options subsettings."}},"description":"The set up information for checking in and out of a Zoom Room."},"under_construction":{"type":"boolean","description":"Rooms with under construction mode enabled are hidden on the dashboard by default and all issue notifications are disabled. You can change your dashboard filters to show rooms under construction if you prefer.","example":true},"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is true, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`.","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"When the background image is a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), this field will contain the `content_id`. When a background image has been directly uploaded, this field will be empty.\"","example":"zrd9DycNSxK6K4dEUS6z-g"},"download_url":{"type":"string","description":"The URL where the background image file may be downloaded. This URL will be expire according to the `download_url_ttl`.","example":"https://zoom.us/file/Sq2mdxqRQ9eq7wmD5TFD6g?jwt=eyJ0eXAiOiJKV1QiLCJrIjoiaHRlNU05dDciLCJ6bV9za20iOiJ6bV9vMm0iLCJhbGc"},"download_url_ttl":{"type":"integer","description":"The time to live of the download URL, in seconds. When this field is not present, the link will never expire.","example":3600}}}},"pro_device":{"type":"boolean","description":"If enabled, the Personal Zoom Room will consume a Zoom Rooms license and have access to \"Pro\" features.  Note: this field will only be present for Personal Zoom Rooms.","example":true}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.\n* Access restricted. \n* No permission to regenerate an activation code for a Zoom Room. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room not found: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-granular-scopes":["zoom_rooms:read:room:master"]}},"delete":{"tags":["Zoom Rooms"],"summary":"Delete a Zoom Room","description":"[Remove](https://support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account.  \n   \n \n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteAZoomRoom","parameters":[{"name":"roomId","in":"path","description":"Unique identifier of a Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**   \n \nZoom Room deleted successfully.\n"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.<br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `1012` <br>\n Room not found:{roomId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:delete:room:master"]}},"patch":{"tags":["Zoom Rooms"],"summary":"Update a Zoom Room profile","description":"Update basic information on a specific Zoom Room in a Zoom account.  \n \n\n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateRoomProfile","parameters":[{"name":"roomId","in":"path","description":"The unique identifier of a Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"hide_room_in_contacts":{"type":"boolean","description":"Hide this Zoom Room from your Contact List.","example":true},"zoom_room_type":{"type":"string","description":"The room type: Kiosk, ZoomRoom, StandaloneWhiteboard, SchedulingDisplayOnly, DigitalSignageOnly,PersonalZoomRoom","example":"ZoomRoom","enum":["Kiosk","ZoomRoom","StandaloneWhiteboard","SchedulingDisplayOnly","DigitalSignageOnly","PersonalZoomRoom"]},"name":{"type":"string","description":"Name of the Zoom Room.","example":"My Personal Meeting Room"},"display_name":{"type":"string","description":"The short display name of the Zoom Room.","example":"My Personal Meeting Room"},"required_code_to_ext":{"type":"boolean","description":"Require code to exit out of Zoom Rooms application to switch between other apps.\n","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"1-16 digit number or characters used to secure your Zoom Rooms application. This code must be entered on your Zoom Room Controller to change settings or sign out.","example":"975193018"},"support_email":{"type":"string","description":"The email address to use for reporting Zoom Room issues.","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number to use for reporting Zoom Room issues.\n","example":"18798769876"},"calendar_resource_id":{"type":"string","description":"The calendar resource's ID. If the value of this field is empty (`&quot;&quot;`), the calendar resource will be removed from Zoom Room.","example":"u7GQ3q_zQbqJnNp02-oMjQ"},"tag_ids":{"type":"array","description":"The list of tag ID to be associated with the Zoom room.","items":{"type":"string","description":"The  tag ID to be associated with the Zoom room.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"}},"use_display_name_on_scheduling_display":{"type":"boolean","description":"If enabled, the Zoom Rooms Scheduling Display(s) of this Zoom Room will show the display_name instead of the name.  Note: this setting is only effective if a display_name is configured.","example":true},"use_display_name_on_zoom_rooms_display_and_controller":{"type":"boolean","description":"If enabled, the Zoom Rooms Controller(s) and Zoom Rooms display(s) of this Zoom Room will show the display_name instead of the name.  Note: this setting is only effective if a display_name is configured.","example":true},"use_display_name_in_meetings":{"type":"boolean","description":"If enabled, the Zoom Room will use the display_name instead of the name in meetings; the display_name will be shown in the Zoom meeting participants list and as the Zoom Rooms' label in the meeting video layout of other meeting participants.  Note: this setting is only effective if a display_name is configured and the use_on_zoom_rooms_and_controller setting is enabled.","example":true},"capacity":{"maximum":500,"minimum":1,"type":"integer","description":"The in-room participant capacity of the Zoom Room.","example":1},"show_room_capacity_on_the_zoom_rooms":{"type":"boolean","description":"If enabled, the Zoom Room show the seating capacity the display(s) of the Zoom Room.  Note: this setting is only effective if a capacity is configured.","example":true},"show_room_capacity_on_the_scheduling_display":{"type":"boolean","description":"If enabled, the Zoom Room show the seating capacity the Zoom Rooms Scheduling Display(s) of the Zoom Room.  Note: this setting is only effective if a capacity is configured.","example":true}}},"device":{"type":"object","properties":{"device_profile_id":{"type":"string","description":"The device's profile ID.","example":"J352JVkNRpyAgUaurxmrsh"}},"description":"The information about the device."},"setup":{"type":"object","properties":{"checkin_and_checkout":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable check-in and check-out options.","example":true},"checkin_and_checkout_options":{"type":"object","properties":{"checkin_minutes_prior_to_meeting_start_time":{"type":"integer","description":"Allowed seconds for participants to check-in prior to meeting start time.","example":600},"allowed_minutes_before_release_room_after_no_checkout":{"type":"integer","description":"Allowed seconds before releasing room due to no check-out or Zoom Room activity.","example":600},"enable_new_user_checkin_notification":{"type":"boolean","description":"Notify in-room participants on the Zoom Rooms display when users check in.","example":true},"enable_remove_recurring":{"type":"boolean","description":"Remove recurring meeting series from Zoom Rooms.","example":true},"allowed_consecutive_missed_checkin_before_removing_room":{"type":"integer","description":"Allowed number of consecutive missed check-ins before removing the room from entire meeting series.","example":4}},"description":"Check-in and check-out options subsettings."}},"description":"The set up information for checking in and out of Zoom Room."},"under_construction":{"type":"boolean","description":"Rooms with under construction mode enabled are hidden on the dashboard by default and all issue notifications are disabled. You can change your dashboard filters to show rooms under construction if you prefer.","example":true},"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is `true`, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"To set the background image to a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), set this field to a background image library content item's `content_id`. To reset the background, set the content_id to an empty string.","example":"LHMmOOYaRiOA5m5WZjXVPA"}}}},"pro_device":{"type":"boolean","description":"If enabled, the Personal Zoom Room will consume a Zoom Rooms license and have access to \"Pro\" features.  Note: this field will only be present for Personal Zoom Rooms.","example":true},"screen_lock_pin":{"type":"string","description":"Set a 6-digit screen lock pin.  Only numeric characters are allowed.  Note: this field will only be present for Personal Zoom Rooms.","example":"123456"}}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**   Zoom Room profile information updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\n**Access restricted**.<br><br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Zoom Room not found: {roomId}.<br><br>. <br>\n**Error Code:** `8005` <br>\n Zoom Room device profile does not exist: {roomId}.<br><br> <br>\n**Error Code:** `4060` <br>\n Calendar resource does not exist: {resourceId}.<br><br> <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-granular-scopes":["zoom_rooms:update:room:master"]}}},"/accounts/{accountId}/rooms/{roomId}/device_profiles":{"get":{"tags":["Zoom Rooms"],"summary":"List device profiles","description":"Returns a list of Zoom Room device profiles.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_device_profiles:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getRoomProfiles","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nDevice profiles returned.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"audio_processing":{"type":"boolean","description":"Whether audio processing is enabled.","example":false},"auto_adjust_mic_level":{"type":"boolean","description":"Whether microphone level auto adjust is enabled.","example":true},"camera_id":{"type":"string","description":"The camera's device ID.","example":"usb#vid_0bda&pid_58fd&mi_00#6&1e7cbc97&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}global"},"echo_cancellation":{"type":"boolean","description":"Whether echo cancellation is enabled.","example":true},"id":{"type":"string","description":"The device's profile ID.","example":"Gz_fNcaSPByng-3vsqv_iQ"},"microphone_id":{"type":"string","description":"The microphone's device ID.","example":"{0.0.2.00000000}.{eff76572-ac52-4c79-bd30-67f968bjb15f}"},"name":{"type":"string","description":"The device profile's name.","example":"ZR1 Device"},"noise_suppression":{"type":"string","description":"The noise suppression setting: \n* `moderate` &mdash; Moderate noise suppression. \n* `aggressive` &mdash; Aggressive noise suppression. \n* `none` &mdash; Noise suppression disabled.","example":"aggressive","enum":["moderate","aggressive","none"]},"speaker_id":{"type":"string","description":"The speaker's device ID.","example":"{0.0.0.00000000}.{4f9b30cb-872e-49ed-a1b9-a7ec352bf3e6}"}},"description":"The information about the Zoom Room's device profile."}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Zoom Room ID does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:list_device_profiles:master"]}},"post":{"tags":["Zoom Rooms"],"summary":"Create a device profile","description":"Creates a Zoom Room device profile.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:device_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"createRoomDeviceProfile","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"audio_processing":{"type":"boolean","description":"Whether to enable audio processing.","example":false},"auto_adjust_mic_level":{"type":"boolean","description":"Whether to enable microphone level auto adjust.","example":true},"camera_id":{"type":"string","description":"The camera's device ID.","example":"usb#vid_0bda&pid_58fd&mi_00#6&1e7cbc97&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}global"},"echo_cancellation":{"type":"boolean","description":"Whether to enable echo cancellation.","example":true},"microphone_id":{"type":"string","description":"The microphone's device ID.","example":"{0.0.2.00000000}.{eff76572-ac52-4c79-bd30-67f968bjb15f}"},"name":{"type":"string","description":"The device profile's name.","example":"ZR1 Device"},"noise_suppression":{"type":"string","description":"The noise suppression setting: \n* `moderate` &mdash; Moderate noise suppression. \n* `aggressive` &mdash; Aggressive noise suppression. \n* `none` &mdash; Noise suppression disabled.","example":"none","enum":["moderate","aggressive","none"]},"speaker_id":{"type":"string","description":"The speaker's device ID.","example":"{0.0.0.00000000}.{4f9b30cb-872e-49ed-a1b9-a7ec352bf3e6}"}},"description":"Information about the Zoom Room device profile."}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` **Created**  \n \nDevice profile successfully created."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n**Error Code:** `300` <br>\n Unable to create device profile because there is no microphone/speaker/camera available in the following Zoom Room: {roomId}. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:device_profile:master"]}}},"/accounts/{accountId}/rooms/{roomId}/device_profiles/devices":{"get":{"tags":["Zoom Rooms"],"summary":"Get device information","description":"Returns information about a Zoom Room device.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getRoomDevices","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \n Device information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"cameras":{"type":"array","description":"Information about the Zoom Room device's cameras.","items":{"type":"object","properties":{"id":{"type":"string","description":"The camera's device ID.","example":"usb#vid_0bda&pid_58fd&mi_00#6&1e7cbc97&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}global"},"name":{"type":"string","description":"The camera's device name.","example":"Integrated Webcam"}}}},"microphones":{"type":"array","description":"Information about the Zoom Room device's microphone.","items":{"type":"object","properties":{"id":{"type":"string","description":"The microphone's device ID.","example":"{0.0.1.00000000}.{eff76542-ac52-4c78-bd90-67f968bab16f}"},"name":{"type":"string","description":"The microphone's device name.","example":"Realtek(R) Audio"}}}},"speakers":{"type":"array","description":"Information about the Zoom Room device's speakers.","items":{"type":"object","properties":{"id":{"type":"string","description":"The speaker's device ID.","example":"{0.0.0.00000000}.{4f9b30cb-872e-49ed-a1b9-a7ec352bf3e6}"},"name":{"type":"string","description":"The speaker's device name.","example":"Realtek(R) Audio"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Zoom Room ID does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"]}}},"/accounts/{accountId}/rooms/{roomId}/device_profiles/{deviceProfileId}":{"get":{"tags":["Zoom Rooms"],"summary":"Get a device profile","description":"Returns a Zoom Room device profile.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:device_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getRoomProfile","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"deviceProfileId","in":"path","description":"The Zoom Room device profile's ID.","required":true,"style":"simple","schema":{"type":"string","example":"pwkZtOnUSIqY7PbWxbH4IA"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nDevice profile returned.","content":{"application/json":{"schema":{"type":"object","properties":{"audio_processing":{"type":"boolean","description":"Whether audio processing is enabled.","example":false},"auto_adjust_mic_level":{"type":"boolean","description":"Whether microphone level auto adjust is enabled.","example":true},"camera_id":{"type":"string","description":"The camera's device ID.","example":"usb#vid_0bda&pid_58fd&mi_00#6&1e7cbc97&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}global"},"echo_cancellation":{"type":"boolean","description":"Whether echo cancellation is enabled.","example":true},"id":{"type":"string","description":"The device's profile ID.","example":"Gz_fNcaSPByng-3vsqv_iQ"},"microphone_id":{"type":"string","description":"The microphone's device ID.","example":"{0.0.2.00000000}.{eff76572-ac52-4c79-bd30-67f968bjb15f}"},"name":{"type":"string","description":"The device profile's name.","example":"ZR1 Device"},"noise_suppression":{"type":"string","description":"The noise suppression setting: \n* `moderate` &mdash; Moderate noise suppression. \n* `aggressive` &mdash; Aggressive noise suppression. \n* `none` &mdash; Noise suppression disabled.","example":"aggressive","enum":["moderate","aggressive","none"]},"speaker_id":{"type":"string","description":"The speaker's device ID.","example":"{0.0.0.00000000}.{4f9b30cb-872e-49ed-a1b9-a7ec352bf3e6}"}},"description":"The information about the Zoom Room's device profile."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room does not exist: {roomId}. <br>\n**Error Code:** `8005` <br>\n Zoom Room device profile does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:device_profile:master"]}},"delete":{"tags":["Zoom Rooms"],"summary":"Delete a device profile","description":"Deletes a Zoom Room device profile.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:delete:device_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"deleteRoomProfile","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"deviceProfileId","in":"path","description":"The Zoom Room device profile's ID.","required":true,"style":"simple","schema":{"type":"string","example":"pwkZtOnUSIqY7PbWxbH4IA"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nDevice profile deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n**Error Code:** `300` <br>\n You cannot delete this device profile. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:delete:device_profile:master"]}},"patch":{"tags":["Zoom Rooms"],"summary":"Update a device profile","description":"Updates a Zoom Room device profile.  **Prerequisites:** * A Pro or a higher account with Zoom Rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:device_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateDeviceProfile","parameters":[{"name":"roomId","in":"path","description":"The Zoom Room's ID.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"deviceProfileId","in":"path","description":"The Zoom Room device profile's ID.","required":true,"style":"simple","schema":{"type":"string","example":"pwkZtOnUSIqY7PbWxbH4IA"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"audio_processing":{"type":"boolean","description":"Whether to enable audio processing.","example":false},"auto_adjust_mic_level":{"type":"boolean","description":"Whether to enable microphone level auto adjust.","example":true},"camera_id":{"type":"string","description":"The camera's device ID.","example":"usb#vid_0bda&pid_58fd&mi_00#6&1e7cbc97&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}global"},"echo_cancellation":{"type":"boolean","description":"Whether to enable echo cancellation.","example":true},"microphone_id":{"type":"string","description":"The microphone's device ID.","example":"{0.0.2.00000000}.{eff76572-ac52-4c79-bd30-67f968bjb15f}"},"noise_suppression":{"type":"string","description":"The noise suppression setting: \n* `moderate` &mdash; Moderate noise suppression. \n* `aggressive` &mdash; Aggressive noise suppression. \n* `none` &mdash; Noise suppression disabled.","example":"none","enum":["moderate","aggressive","none"]},"speaker_id":{"type":"string","description":"The speaker's device ID.","example":"{0.0.0.00000000}.{4f9b30cb-872e-49ed-a1b9-a7ec352bf3e6}"}},"description":"Information about the Zoom Room device profile."}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nDevice profile updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n * Zoom Room subscription not found. Purchase a Zoom Room subscription and try again. <br>\n* Access restricted. <br>\n**Error Code:** `300` <br>\n You cannot change this device profile. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1012` <br>\n Room does not exist: {roomId}. <br>\n**Error Code:** `8005` <br>\n Room device profile does not exist: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:device_profile:master"]}}},"/accounts/{accountId}/rooms/{roomId}/devices":{"get":{"tags":["Zoom Rooms"],"summary":"List Zoom Room devices","description":"List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account.\n\n**Prerequisites:**  \n \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.  \n \n* Account owner or admin permissions.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_devices:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"listZRDevices","parameters":[{"name":"roomId","in":"path","description":"Unique Identifier of the Zoom Room. This can be retrieved from the response of [**List Zoom Rooms**](/docs/api-reference/zoom-api/methods#operation/listZoomRooms) API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**\nDevices listed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"app_version":{"type":"string","description":"App version of Zoom Rooms.","example":"5.9.1 (2581)"},"device_system":{"type":"string","description":"Operating system of the device.","example":"Win10 Build 19043.1266"},"device_type":{"type":"string","description":"Type of the device. The value of this field can be one of the following:  \n `Zoom Rooms Computer`,  \n  `Controller`, `Scheduling Display`, `Zoom Rooms Control System`, `Companion Whiteboard`","example":"Controller","enum":["Zoom Rooms Computer","Controller","Scheduling Display","Zoom Rooms Control System","Companion Whiteboard"]},"id":{"type":"string","description":"Unique identifier of the device.","example":"{0.0.1.00000000}.{eff76542-ac52-4c78-bd90-67f968bab16f}"},"room_name":{"type":"string","description":"Name of the Zoom Room.","example":"My Room"},"status":{"type":"string","description":"Status of the device. The value can be either `Online` or `Offline`.","example":"Online","enum":["Online","Offline"]},"device_mac_addresses":{"type":"array","description":"Array of device mac addresses","example":["01-23-45-67-89-AB"],"items":{"type":"string","description":"Device mac address","example":"01-23-45-67-89-AB"}},"device_hostname":{"type":"string","description":"The device's name","example":"Test Computer"},"device_manufacturer":{"type":"string","description":"The device's manufacturer","example":"Poly"},"device_model":{"type":"string","description":"The device's model","example":"MacBookPro14,1"},"device_firmware":{"type":"string","description":"The device's firmware version","example":"1.1.1"},"ip_address":{"type":"string","description":"The device IP address.","example":"10.10.10.10"},"serial_number":{"type":"string","description":"The device serial number.","example":"6NRN2A0"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:list_devices:master"]}}},"/accounts/{accountId}/rooms/{roomId}/location":{"put":{"tags":["Zoom Rooms"],"summary":"Change a Zoom Room's location","description":"An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy.\n**Prerequisite:**  \n \n* Account owner or admin permission\n* Zoom Rooms version 4.0 or higher  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:room_location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"changeZRLocation","parameters":[{"name":"roomId","in":"path","description":"Unique Identifier of the Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location_id":{"type":"string","description":"Location ID of the location where Zoom Room is to be assigned. This can be retrieved from the `id` property in the response of [**List Zoom Rooms locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API.","example":"49D7a0xPQvGQ2DCMZgSe7w"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nLocation of the Zoom Room changed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4801` <br>\n Location not found: {location_id} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:room_location:master"]}}},"/accounts/{accountId}/rooms/{roomId}/virtual_controller":{"get":{"tags":["Zoom Rooms"],"summary":"Get Zoom Rooms virtual controller URL","description":"Get the Zoom Rooms virtual controller URL. \n\n**Prerequisites:**  \n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:virtual_controller:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getWebzrcUrl","parameters":[{"name":"roomId","in":"path","description":"The unique identifier of the Zoom Room. This can be retrieved from the response of the List Zoom Rooms API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"pre_authenticated_link","in":"query","description":"If true, the URL for the virtual controller will contain a time-limited authentication token (10 minute lifetime) that will permit to the virtual controller without requiring login to Zoom admin portal.  Default is false.","required":false,"style":"form","schema":{"type":"boolean","example":false}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`**OK** Zoom Rooms virtual controller URL returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The Zoom Rooms virtual controller URL.","example":"https://zoom.us/launch/webzrc?nodeId=SnoDt6rcTqi7HIuFZsib9A"},"expire_in":{"type":"integer","description":"Expiry time of a pre-authenticated link in seconds.","example":600}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300520003` <br>\n Check Zoom Room error. Failed to launch Zoom Rooms virtual controller. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n **Error Code:** `300520001` <br>\n User not logged in. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `300520002` <br>\n No Zoom Rooms found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["ZRWebController:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:virtual_controller:admin"]}}},"/accounts/{accountId}/rooms/account_profile":{"get":{"tags":["Zoom Rooms Account"],"summary":"Get Zoom Room account profile","description":"Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual room profile, use the [**Get Zoom Room profile**](/docs/api-reference/zoom-api/methods#operation/getZRProfile) API. \n\n**Prerequisites:**  \n \n* Zoom account owner or Zoom Rooms admin permissions.  \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:account_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRAccountProfile","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Room Account Profile returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"required_code_to_ext":{"type":"boolean","description":"The required code to exit out of the Zoom Rooms application to switch between other apps.\n","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"The 1-16 digit number or characters used to secure your Zoom Rooms application. This code must be entered on your Zoom Room Controller to change settings or to sign out.","example":"111111"},"support_email":{"type":"string","description":"The email address used for reporting Zoom Room issues.","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number used for reporting Zoom Room issues.","example":"18798769876"}}},"setup":{"type":"object","properties":{"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is true, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`.","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"When the background image is a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), this field will contain the `content_id`. When a background image has been directly uploaded, this field will be empty.\"","example":"zrd9DycNSxK6K4dEUS6z-g"},"download_url":{"type":"string","description":"The URL where the background image file may be downloaded. This URL will be expire according to the `download_url_ttl`.","example":"https://zoom.us/file/Sq2mdxqRQ9eq7wmD5TFD6g?jwt=eyJ0eXAiOiJKV1QiLCJrIjoiaHRlNU05dDciLCJ6bV9za20iOiJ6bV9vMm0iLCJhbGc"},"download_url_ttl":{"type":"integer","description":"The time to live of the download URL, in seconds. When this field is not present, the link will never expire.","example":3600}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:account_profile:master"]}},"patch":{"tags":["Zoom Rooms Account"],"summary":"Update Zoom Room account profile","description":"Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual room profile, use the [**Update a Zoom Room profile**](/docs/api-reference/zoom-api/methods#operation/updateRoomProfile) API. \n\n**Prerequisites:**  \n \n* Zoom account owner or Zoom Rooms admin permissions.  \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:account_profile:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZRAccProfile","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"required_code_to_ext":{"type":"boolean","description":"The required code to exit out of the Zoom Rooms application to switch between other apps.\n","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"The 1-16 digit number or characters used to secure your Zoom Rooms application. This code must be entered on your Zoom Room Controller to change settings or to sign out.","example":"975193018"},"support_email":{"type":"string","description":"The email address used for reporting Zoom Room issues.","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number used for reporting Zoom Room issues.","example":"18798769876"}}},"setup":{"type":"object","properties":{"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is `true`, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`.","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"To set the background image to a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), set this field to a background image library content item's `content_id`. To reset the background, set the content_id to an empty string.","example":"LHMmOOYaRiOA5m5WZjXVPA"}}}}}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nProfile updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\n**Access restricted**. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:account_profile:master"]}}},"/accounts/{accountId}/rooms/account_settings":{"get":{"tags":["Zoom Rooms Account"],"summary":"Get Zoom Room account settings","description":"Get details on Account Settings of a Zoom Room. With this API, you can view the **Account Meeting Settings**, **Alert Settings** (Client Alert Settings and Notification Settings), **Digital Signage Settings** or **Scheduling Display Settings** of the Zoom Rooms account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.  \n   \n \n**Prerequisites:**  \n \n* Zoom Room licenses.\n* Owner or Admin privileges on the Zoom Account.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:account_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRAccountSettings","parameters":[{"name":"setting_type","in":"query","description":"The type of setting that you would like to retrieve.\n\n`alert`: Alert settings of the Zoom Rooms Account.\n \n`meeting`: Meeting settings of the Zoom Rooms Account.\n \n`signage`: Digital Signage settings of the Zoom Rooms Account.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Rooms Account.","required":true,"style":"form","schema":{"type":"string","example":"meeting","default":"meeting","enum":["meeting","alert","signage","scheduling_display"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZR Account Settings returned successfully.\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"email_address_prompt_before_recording":{"type":"boolean","description":"Allow in-room participants to input email address where they can receive the recording before starting a recording if the meeting was created on the Scheduling Display or if it was started using the &quot;Meet Now&quot; option.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"make_room_alternative_host":{"type":"boolean","description":"Set [Zoom Rooms as the alternative host](https://support.zoom.us/hc/en-us/articles/203614149-Zoom-Rooms-as-Alternative-Host).\n","example":true},"secure_connection_channel":{"type":"boolean","description":"Enable secure connection between Zoom Rooms computer and controller.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"show_non_video_participants":{"type":"boolean","description":"When enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Rooms display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"start_airplay_mirroring":{"type":"boolean","description":"Allow users to share content via Apple Screen Mirroring (called Airplay on iOS 11 or earlier) in Zoom Rooms","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true}}}}},{"type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","description":"Display or hide banner room name.","example":true},"banner_sharing_key":{"type":"boolean","description":"Display or hide banner sharing key.","example":true},"banner_time":{"type":"boolean","description":"Display or hide time in the banner.","example":true}},"description":"Specifies the elements that you want to display in the top banner."},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. The value of this field indicates the duration in minutes.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. The value of this field indicates the duration in minutes.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Indicates whether digital signage is on or off,](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"true"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"add","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"Duration for how long the content will be displayed.","example":65},"id":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"},"name":{"type":"string","description":"Name of the content.","example":"content name"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content list"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:account_settings:master"]}},"patch":{"tags":["Zoom Rooms Account"],"summary":"Update Zoom Room account settings","description":"Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update the **Account Meeting Settings**, **Alert Settings** (Client Alert Settings and Notification Settings), **Digital Signage Settings** or **Scheduling Display 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.  \n   \n \n**Prerequisites:**  \n \n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:account_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZoomRoomAccSettings","parameters":[{"name":"setting_type","in":"query","description":"The type of setting that you would like to update.  \n\n`alert`: Alert settings of the Zoom Rooms Account.\n \n`meeting`: Meeting settings of the Zoom Rooms Account.\n \n`signage`: Digital Signage settings of the Zoom Rooms Account.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Rooms Account.","required":true,"style":"form","schema":{"type":"string","example":"meeting","default":"meeting"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"email_address_prompt_before_recording":{"type":"boolean","description":"Allow in-room participants to input email address where they can receive the recording before starting a recording if the meeting was created on the Scheduling Display or if it was started using the &quot;Meet Now&quot; option.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"make_room_alternative_host":{"type":"boolean","description":"Set [Zoom Rooms as the alternative host](https://support.zoom.us/hc/en-us/articles/203614149-Zoom-Rooms-as-Alternative-Host).\n","example":true},"secure_connection_channel":{"type":"boolean","description":"Enable secure connection between Zoom Rooms computer and controller.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"show_non_video_participants":{"type":"boolean","description":"When enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Rooms display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true}}}}},{"type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","example":true},"banner_sharing_key":{"type":"boolean","example":true},"banner_time":{"type":"boolean","example":true}}},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. Specify the value of the duration in minutes in this field.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. Specify the value of duration in minutes in this field.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Enable or disable digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"standard"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"add","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content in the content list. The value can be one of the following:  \n \n`add`: Add another content to the content list.  \n \n`update`: Update existing content's information in the content list.  \n \n`delete`: Delete content from the content list.\n\n","example":"add"},"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"By default each content is display for 5 seconds. Using this field, specify how long you would like to display the content.","example":65},"id":{"type":"string","description":"Unique identifier of the content. This field is only required if you would like to remove or update the content information.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content.","example":"name content"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content list"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_stable_detected":{"type":"boolean","description":"Send an alert when the network is stable.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nSettings updated successfully.\n"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:account_settings:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/contents":{"get":{"tags":["Zoom Rooms Content"],"summary":"List Digital Signage content items","description":"Returns a list of Zoom Rooms digital signage library base folder content items.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GETListdigitalsignagecontentitems","parameters":[{"name":"page_size","in":"query","description":"The number of records, returned within a single API call. Default: 30，Max: 200.","required":true,"style":"form","schema":{"maximum":200,"minimum":1,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nList of digital signage library content items successful.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2\n"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":1},"contents":{"maxItems":200,"type":"array","description":"List of digital signage library content items","items":{"type":"object","properties":{"content_id":{"type":"string","description":"The content ID.","example":"4zOa0MAVGyMEB2"},"content_type":{"type":"string","description":"The content type.","example":"image","enum":["image","video","url"]},"content_name":{"type":"string","description":"If the content item is a picture or video, the file name.  If the content item is a URL, the URL.","example":"example.jpg"}},"description":"content items"}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `30051005` <br>\n Invalid next_page_token or page_size. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_contents:master"]}},"post":{"tags":["Zoom Rooms Content"],"summary":"Add a digital signage URL","description":"Use this API to add a URL to the Zoom Rooms digital signage content library.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"AddadigitalsignageURL","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content_name":{"type":"string","description":"The file content name.","example":"Example Website URL"},"content_url":{"type":"string","description":"The file content URL.","example":"https://example.com/example"},"folder_id":{"type":"string","description":"The folder ID.","example":"LHMmOOYaRiOA5m5WZjXVPA"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` **OK**\n\nAdd a digital signage URL successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"content_id":{"type":"string","description":"The content item ID.","example":"ulx2iq6lTAOVTflXCrS4LQ"}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/contents/{contentId}":{"get":{"tags":["Zoom Rooms Content"],"summary":"Get Digital Signage content item","description":"Use this API to get the details of an individual digital signage content item.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Getdigitalsignagecontentitem","parameters":[{"name":"contentId","in":"path","description":"The content ID.","required":true,"style":"simple","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nGet digital signage content item successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"content_id":{"type":"string","description":"Unique identifier of the content item.","example":"HE-d7lrSR4qqxC12noVtaA"},"content_type":{"type":"string","description":"The content item type.","example":"url","enum":["image","video","url"]},"content_name":{"type":"string","description":"The name of the content item.","example":"example url"},"content_url":{"type":"string","description":"If the content item is a URL, the target URL.  If the content item is an image or video, this field will be empty.","example":"https://zoom.us"},"expires":{"type":"boolean","description":"If set to `true`, the content will expire at the configured expiration_time.  Default: `false`.","example":false},"expiration_time":{"type":"string","description":"If expires is true, the content will expire after the configured time.","format":"date-time"},"folder_id":{"type":"string","description":"Unique identifier of the digital signage content folder where the content is located.  If the item is in the root folder, the folder_id will be empty.","example":"7lrSR4qqxC11HQVtaArtvg"},"download_url":{"type":"string","description":"If the content item is an image or video, the URL where the file can be downloaded.  If the content item is a URL, this field will be empty. This URL will be expire according to the download_url_ttl.","example":"https://fileserver.zoom.us/rescfdrddvdwssw123"},"download_url_ttl":{"type":"integer","description":"The time to live of the download URL, in seconds.","example":300}}}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_contents:master"]}},"delete":{"tags":["Zoom Rooms Content"],"summary":"Delete a Digital Signage content item","description":"Use this API to delete an individual digital signage content item.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Deleteadigitalsignagecontentitem","parameters":[{"name":"contentId","in":"path","description":"Unique identifier of the digital signage content","required":true,"style":"simple","schema":{"type":"string","example":"U0V35NT8RdCWUKsU-MLm-g"}},{"name":"remove_from_library_only","in":"query","description":" If set to `true`, the content item will be removed from the content library only.  If set to `false`, the content item will be removed from the content library and from any playlists and/or Zoom Room content lists that reference the content library item.","required":false,"style":"form","schema":{"type":"boolean","example":true}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":" **HTTP Status Code:** `204` **OK**\n \n Delete a digital signage content successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}},"patch":{"tags":["Zoom Rooms Content"],"summary":"Update a Digital Signage content item attributes","description":"Use this API to update a digital signage content item's attributes.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateadigitalsignagecontentitemattributes","parameters":[{"name":"contentId","in":"path","description":"The content ID.","required":true,"style":"simple","schema":{"type":"string","example":"4zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content_name":{"type":"string","description":"The name of the content item.","example":"Example Website URL"},"content_url":{"type":"string","description":" Changes the target URL of a digital signage content item of the URL type.  This field will be ignored for image or video content items.","example":"https://example.com/example"},"expires":{"type":"boolean","description":"If set to `true`, the content will expire at the configured expiration_time.  Default: `false`.","example":true},"expiration_time":{"pattern":"yyyy-MM-dd HH:mm:ss","type":"string","description":"If `expires` is `true`, `expiration_time` is required, and the content will expire after the configured time. Format: `uuuu-MM-dd HH:mm:ss`.","format":"date-time"},"auto_remove_from_playlist_when_expired":{"type":"boolean","description":"If set to `true`, the content will be automatically removed from the playlist at the configured `expiration_time`. Default: `false`.","example":true},"timezone":{"type":"string","description":"The timezone of the expiration time. If `expires` is `true`, `timezone` is required.","example":"UTC"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **OK**\n\nUpdate a digital signage content item attributes successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/folders":{"post":{"tags":["Zoom Rooms Content"],"summary":"Add a digital signage content folder","description":"Use this API to add a Digital Signage Content folder.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Addadigitalsignagecontentfolder","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folder_name":{"type":"string","description":"The digital signage content folder name.","example":"testfolder"}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `201` **Created** \n\nAdd a digital signage folder successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"string","description":"The folder ID.","example":"idV95eT8RdCds23U-NLo-a"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/folders/{folderId}":{"get":{"tags":["Zoom Rooms Content"],"summary":"Get Digital Signage content folder","description":"Use this API to get the details of an individual digital signage content folder.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Getdigitalsignagecontentfolderdetails","parameters":[{"name":"folderId","in":"path","description":"Unique identifier of the digital signage content folder.","required":true,"style":"simple","schema":{"type":"string","example":"idV95eT8RdCds23U-NLo-a"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**\n\nGet a digital signage folder successfully.\"","content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"string","description":"Unique identifier of the digital signage content folder.","example":"idV95eT8RdCds23U-NLo-a"},"folder_name":{"type":"string","description":"The digital signage content folder name.","example":"testfolder"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_contents:master"]}},"delete":{"tags":["Zoom Rooms Content"],"summary":"Delete a Digital Signage content folder","description":"Use this API to delete an individual digital signage content folder.  **Note**: All digital signage content items in this folder will also be deleted.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Deleteadigitalsignagecontentfolder","parameters":[{"name":"folderId","in":"path","description":"The folder ID.","required":true,"style":"simple","schema":{"type":"string","example":"idV95eT8RdCds23U-NLo-a"}},{"name":"remove_from_library_only","in":"query","description":"If set to `true`, the folder and all its content item(s) will be removed from the content library only.  If set to `false`, the folder and all its content item(s) will be removed from the content library and from any playlists and/or Zoom Room content lists that reference the content library item(s).","required":false,"style":"form","schema":{"type":"boolean","example":true}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"*HTTP Status Code:** `204` **No Content**\n\nDelete digital signage folder successful."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}},"patch":{"tags":["Zoom Rooms Content"],"summary":"Update a digital signage content folder","description":"Updates a Digital Signage content folder’s attributes.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateadigitalsignagecontentfolder","parameters":[{"name":"folderId","in":"path","description":"The folder ID.","required":true,"style":"simple","schema":{"type":"string","example":"idV95eT8RdCds23U-NLo-a"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folder_name":{"type":"string","description":"The digital signage content folder name.","example":"myfolder"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No content**\n\nUpdate digital signage content folder successful.\n\n"}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/playlists":{"get":{"tags":["Zoom Rooms Content"],"summary":"List Digital Signage library playlists","description":" Returns a list of Zoom Rooms content library digital signage playlists.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListDigitalSignagelibraryplaylists","parameters":[{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"style":"form","schema":{"maximum":300,"minimum":1,"type":"integer","example":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK** \n\nList playlist successful.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"ecfJX3jsOLW7w3dokmF90czOa0MAVGyMEB2"},"page_size":{"type":"integer","description":" The number of records returned within a single API call.","example":10},"playlists":{"maxItems":300,"type":"array","items":{"type":"object","properties":{"playlist_id":{"type":"string","description":" The playlist id","example":"U0V35NT8RdCWUKsU-MLm-g"},"playlist_name":{"type":"string","description":" The playlist name","example":"myplaylist"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_playlists:master"]}},"post":{"tags":["Zoom Rooms Content"],"summary":"Add a Digital Signage library playlist","description":"Use this API to add a content library Digital Signage Playlist.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"AddaDigitalSignagelibraryplaylist","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["playlist_name"],"type":"object","properties":{"playlist_name":{"type":"string","description":"The playlist name","example":"my playlist"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` **Created**\n\nAdd digital signage playlist successful.","content":{"application/json":{"schema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"The playlist ID.","example":"U0V35NT8RdCWUKsU-MLm-g"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_playlists:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/playlists/{playlistId}":{"get":{"tags":["Zoom Rooms Content"],"summary":"Get Digital Signage library playlist","description":"Returns a Zoom Rooms content library digital signage playlist.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetDigitalSignagelibraryplaylist","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the list digital signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK** \n\nGet Zoom Rooms content library digital signage playlist successful.","content":{"application/json":{"schema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"The playlist ID.","example":"U0V35NT8RdCWUKsU-MLm-g"},"playlist_name":{"type":"string","description":"The playlist name.","example":"myplaylist"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_playlists:master"]}},"delete":{"tags":["Zoom Rooms Content"],"summary":"Delete Digital Signage library playlist","description":"Delete digital signage library playlist.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DeleteDigitalSignagelibraryplaylist","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"description":"Deletes a Zoom Rooms content library digital signage playlist.  \n**Note**: This will remove the playlist from the content library, all locations it was published, and be removed from all Zoom Room content lists that included the playlist."},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**\n\nZoom Rooms content library digital signage playlist deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_playlists:master"]}},"patch":{"tags":["Zoom Rooms Content"],"summary":"Update a Digital Signage library playlist","description":"Updates a Zoom Rooms content library digital signage playlist.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateaDigitalSignagelibraryplaylist","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"playlist_name":{"type":"string","description":"The playlist name.","example":"myplaylist"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**\n\nUpdate a Digital Signage library playlist successful."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_playlists:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/playlists/{playlistId}/contents":{"get":{"tags":["Zoom Rooms Content"],"summary":"Get Digital Signage library playlist content items","description":"Returns a Zoom Rooms content library digital signage playlist content items and their metadata.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetDigitalSignagelibraryplaylistcontentitems","parameters":[{"name":"playlistId","in":"path","description":" The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"style":"form","schema":{"maximum":300,"minimum":1,"type":"integer","example":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**\n\nGet a digital signage playlist contents successfully.\"","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"maxItems":300,"type":"array","description":"List of content items in the playlist.  The items are provided in order.","items":{"type":"object","properties":{"content_id":{"type":"string","description":"The content item ID.","example":"U0V35NT8RdCWUKsU-MLm-g"},"content_name":{"type":"string","description":"The content item name","example":"example.jpg"},"content_duration":{"type":"integer","description":"The content item play duration, in seconds.","example":10}}}},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":20}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_playlists:master"]}},"put":{"tags":["Zoom Rooms Content"],"summary":"Update Digital Signage library playlist content items","description":"Updates a Zoom Rooms content library digital signage playlist content items and their metadata.  This API replaces the entire playlist.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateDigitalSignagelibraryplaylistcontentitems","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"content_id":{"type":"string","description":"The content item ID.","example":"U0V35NT8RdCWUKsU-MLm-g"},"content_duration":{"type":"integer","description":"The content item play duration, in seconds","example":10}},"description":" List of content items to insert the playlist.  The items must be provided in order.  \n **Note**: The playlist contents are entirely replaced with the supplied items."}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content** \n\nUpdate Digital Signage library playlist content items successful."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_playlists:master"]}}},"/accounts/{accountId}/rooms/content/digital_signage/playlists/{playlistId}/rooms":{"get":{"tags":["Zoom Rooms Content"],"summary":"List Digital Signage library playlist published rooms","description":"List Digital Signage library playlist published rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"ListDigitalSignagelibraryplaylistpublishedrooms","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK** \nList Digital Signage library playlist published rooms successfully.","content":{"application/json":{"schema":{"required":["rooms"],"type":"object","properties":{"rooms":{"type":"array","description":"The Zoom Rooms where the playlist is published.","items":{"type":"object","properties":{"room_id":{"type":"string","description":"The Zoom Room ID.","example":"qMOLd574SIGGVycz8aX_sa"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Read"],"x-macro-scopes":["room:read:master"],"x-granular-scopes":["zoom_rooms:read:digital_signage_library_playlists:master"]}},"put":{"tags":["Zoom Rooms Content"],"summary":"Update Digital Signage library playlist published rooms","description":"Update Digital Signage library playlist published rooms.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_playlists:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateDigitalSignagelibraryplaylistpublishedrooms","parameters":[{"name":"playlistId","in":"path","description":"The unique identifier of the playlist. This can be retrieved from the response of the List Digital Signage library playlists API.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"description":"Updates the list of Zoom Rooms where the playlist is published.","content":{"application/json":{"schema":{"type":"object","properties":{"rooms":{"type":"array","description":" The Zoom Rooms where the playlist is published.","items":{"type":"object","properties":{"room_id":{"type":"string","description":"The Zoom Room ID.","example":"345dddnySiujVycz8aX_JQ"}}}}}}}}},"responses":{"204":{"description":"*HTTP Status Code:* `204` **No Content** \nUpdate Digital Signage library playlist published rooms successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:write:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_playlists:master"]}}},"/accounts/{accountId}/zrdigitalsignage/files":{"put":{"tags":["Zoom Rooms Content"],"summary":"Update a Digital Signage image or video file","description":"Update an image or video content item in the Zoom Rooms digital signage content library.\n**Note**: * Base URL: https://fileapi.zoom.us/v2/.\n\n**Rate limit**: 20 requests per second per user or 2000 requests per second per IP address.\n\nThe caller must support HTTP 30x redirects.\n\nThe caller must retain the Authorization header when redirected to a different hostname.\nJPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only).\n\n**Recommended dimensions**\n - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays\nMaximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait)\nYour object size should no more than 10 M.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateadigitalsignageimageorvideofile","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Upload image.\nJPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only).\nRecommended dimensions - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays.\nMaximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait).","format":"binary","example":"Vm0wd2QyUXlVWGxWV0d4WFlUSm9WMVl3Wkc5V2JGbDNXa1pPVlUxV2NIcFhhMXBQVjBaYWMySkVUbGhoTVVwVVZtcEdTMk15U2tWVWJHaG9UV3N3ZUZacVFtRlpWMDE1VTJ0V1ZXSkhhRzlVVmxaM1ZsWmFjVkZ0UmxSTmJFcEpWbTEwVjFWdFNsWlhiR2hYWWxob2VsUlVSbUZrUjA1R1UyMTRVMkpXU2twV2JURXdZVEZrU0ZOclpHcFRSVXBZVkZWYWQxTkdVbFZTYlVaclVsUkdWbFpYZUZOVWJVWTJVbFJHVjFaRmIzZFdha1poVjBaT2NtRkdXbWxoTUhCWlYxWlNSMWxYUmtkV1dHaFlZbGhTV0ZSV2FFTlNiRnBZWlVoa1YwMUVSa1pWYkZKRFZqQXhkVlZ1V2xkaGEzQklWV3BHVDJSV1VuUmpSazVYVWpOb2IxWXhaRFJpTVZGM1RsVmtWbUpyY0ZsWmJGWmhZMVpTVjFkdVpFNVNiRm93V2xWa01GWlhTa2RqUkVaV1ZqTm9kbFpxUmt0ak1rNUhZVVprYUdFelFrbFdWRUpoV1ZkU1YxTnVUbFJpUjFKVVZGUkJkMDFSUFQwPQ=="},"content_id":{"type":"string","description":"The content ID.","example":"zrd9DycNSxK6K4dEUS6z"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content** : Zoom Rooms digital signage content updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:write:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}},"post":{"tags":["Zoom Rooms Content"],"summary":"Add a digital signage image or video ","description":"Upload an image or video to the Zoom Rooms Digital Signage Content Library.\n**Note**: * Base URL: https://fileapi.zoom.us/v2/\n\n**Rate limit**: 20 requests per second per user or 2000 requests per second per IP address.\nThe caller must support HTTP 30x redirects.\n\nThe caller must retain the Authorization header when redirected to a different hostname.\nJPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only)\n\n**Recommended dimensions**:\n\n - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays.\nMaximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait)\nYour object size should no more than 10 M.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:digital_signage_library_contents:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Adddigitalsignageimageorvideo","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["content_name","file"],"type":"object","properties":{"file":{"type":"string","description":"Upload image.\n* JPG/JPEG, 24-bit PNG (no alpha) or GIF (ZR Appliance only).\n* Recommended dimensions - 1920 x 1080 (landscape) or 1080 x 1920 (portrait) for 16:9 aspect ratio displays.\n* Maximum dimensions - 5120 x 2160 (landscape) or 2160 x 5120 (portrait).","format":"binary","example":""},"content_name":{"type":"string","description":"The file content name.","example":"example.jpg"},"folder_id":{"type":"string","description":"The folder ID.","example":"ry6d7lrSR4qqxC11HQ30lc"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` **OK**  \n \nZoom Rooms digital signage library content added successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"content_id":{"type":"string","description":"The content item ID.","example":"ulx2iq6lTAOVTflXCrS4LQ"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DigitalSignage:Edit"],"x-macro-scopes":["room:write:master"],"x-granular-scopes":["zoom_rooms:write:digital_signage_library_contents:master"]}}},"/accounts/{accountId}/rooms/{roomId}/devices/{deviceId}/app_version":{"put":{"tags":["Zoom Rooms Devices"],"summary":"Change Zoom Rooms app version","description":"Use this API to [upgrade or downgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software) the version of your installed Zoom Rooms app on your Mac or Windows device. \n\n**Prerequisites:** \n* A Pro or a higher account with Zoom Rooms. \n* The Zoom Rooms software must be installed on a Mac or a Windows device. This API does not support other devices.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:device_app_version:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"changeZoomRoomsAppVersion","parameters":[{"name":"roomId","in":"path","description":"Unique Identifier of the Zoom Room.","required":true,"style":"simple","schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"deviceId","in":"path","description":"Unique Identifier of the Mac or the Windows device. The value of this field can be retrieved from the [**List Zoom Room devices**](/docs/api-reference/zoom-api/methods#operation/listZRDevices) API.","required":true,"style":"simple","schema":{"type":"string","example":"qsrpAOJCTm-VPkOf3bHXgw"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","description":"Specify one of the following values for this field:\n\n`upgrade`: Upgrade to the latest Zoom Rooms App Version.  \n \n`downgrade`: Downgrade the Zoom Rooms App Version.  \n \n`cancel`: Cancel an ongoing upgrade or downgrade process.","example":"update","enum":["upgrade","downgrade","cancel"]}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**   \n \nRequest processed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `8001` <br>\n Cannot process this upgrade request. The Zoom Rooms Software in this device is either already up to date or is currently being updated.  <br>  <br> <br>\n**Error Code:** `8002` <br>\n Cannot process the downgrade request. The target version for downgrading is not available or the downgrade process has already been initiated. <br>  <br> <br>\n**Error Code:** `8003` <br>\n The cancel request could not be processed because the Zoom Rooms Software in this device is not being downgraded or upgraded at the moment. The cancel action should only be used to cancel an ongoing upgrade or downgrade process. <br>  <br> <br>\n**Error Code:** `8004` <br>\n A device with the provided Device ID: {deviceId} does not belong to the current room: {roomId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:device_app_version:master"]}}},"/accounts/{accountId}/rooms/locations":{"get":{"tags":["Zoom Rooms Location"],"summary":"List Zoom Room locations","description":"A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.  \n   \n \n**Prerequisites:**\n* Account owner or admin permissions.\n* Zoom Rooms Version 4.0 or higher  \n   \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:list_locations:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"listZRLocations","parameters":[{"name":"parent_location_id","in":"query","description":"A unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.","required":false,"style":"form","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"type","in":"query","description":"Use this field to filter the response by the type of location. The value can be one of the following:\n`country`, `states`, `city`, `campus`, `building`, `floor`. ","required":false,"style":"form","schema":{"type":"string","example":"states"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"style":"form","schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"style":"form","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Room locations listed successfully.\n","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","description":"Information about the Zoom Room locations.","items":{"type":"object","properties":{"id":{"type":"string","description":"The location's unique ID.","example":"AAAAAAAAAA"},"name":{"type":"string","description":"The location's name.","example":"BuildingA"},"parent_location_id":{"type":"string","description":"The parent location's unique ID. For example, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1 and the `parent_location_id` of Floor 1 will be the ID of Building A. \n\nThe value of `parent_location_id` of the top-level location (`country`) is the Zoom account's ID.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"type":{"type":"string","description":"The type of location: \n* `country` \n* `states` \n* `city` \n* `campus` \n* `building` \n* `floor`","example":"building","enum":["country","states","city","campus","building","floor"]}}}},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2"},"page_size":{"type":"integer","description":"The number of records returned with a single API call.","example":30}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br> <br>\n**Error Code:** `300` <br>\n Location type not exist.<br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4801` <br>\n Location not found:{parent_location_id}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:list_locations:master"]}},"post":{"tags":["Zoom Rooms Location"],"summary":"Add a location","description":"Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account.\n\n**Prerequisites:**\n* Account owner or admin permissions.\n* Zoom Rooms Version 4.0 or higher  \n   \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"addAZRLocation","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the location. The name must be unique and shouldn't have already been used in the same account.","example":"location name"},"parent_location_id":{"type":"string","description":"The location ID of the location that is a level higher from the location that is being added.  \n   \n  For example, to add a City named &quot;City 1&quot; as the child location under a State named &quot;State 1&quot;, you must provide the location ID of &quot;State 1&quot;. This can be retrieved using the [**List Zoom Room locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API.","example":"49D7a0xPQvGQ2DCMZgSe7w"}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nLocation added successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Location ID: Unique Identifier of the location that was added.","example":"tgg7a0xPDvFn2DCnZgBe8k"},"name":{"type":"string","description":"Name of the location.","example":"location name"},"parent_location_id":{"type":"string","description":"Unique Identifier of the parent location.","example":"49D7a0xPQvGQ2DCMZgSe7w"},"type":{"type":"string","description":"Type of location. The value should be one of the following:  \n \n`country`, `states`, `city`, `campus`, `building`, `floor`.","example":"country","enum":["country","states","city","campus","building","floor"]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br><br> <br>\n**Error Code:** `300` <br>\n Location name already exists. Try a different location name.<br>\nInvalid parent location id {parent_location_id} <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4801` <br>\n Location not exist {parent_location_id}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:location:master"]}}},"/accounts/{accountId}/rooms/locations/structure":{"get":{"tags":["Zoom Rooms Location"],"summary":"Get Zoom Room location structure","description":"Get the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.  \n   \n \n**Prerequisites:**  \n \n* Zoom Rooms version 4.0 or higher.\n* Account owner or admin permissions.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location_hierarchy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getZRLocationStructure","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Rooms location structure returned successfully.  \n \n","content":{"application/json":{"schema":{"type":"object","properties":{"structures":{"type":"array","description":"Hierarchial structure array of the Zoom Rooms location.","items":{"type":"string","example":"country"}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:location_hierarchy:master"]}},"put":{"tags":["Zoom Rooms Location"],"summary":"Update Zoom Rooms location structure","description":"Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.  \n   \n \n**Prerequisites:**  \n \n* Zoom Rooms version 4.0 or higher\n* Account owner or admin permissions  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location_hierarchy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZoomRoomsLocationStructure","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"structures":{"type":"array","description":"Location Structure. The value can be either one or a combination of the following strings separated by comma:\n`country`, `state`, `city`, `campus`, `building`, `floor`","items":{"type":"string","example":"country"}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nLocation Structure updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `2100` <br>\n This sub account has no sip trunk plan <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n This account does not exist or does not belong to this master account.<br>This account does not exist or does not belong to you. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:location_hierarchy:master"]}}},"/accounts/{accountId}/rooms/locations/{locationId}":{"get":{"tags":["Zoom Rooms Location"],"summary":"Get Zoom Room location profile","description":"Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page with information such as the location name, address, support email, and more. Use this API to retrieve information about a specific Zoom Rooms location type, such as the city location of the Zoom Rooms.\n\n**Prerequisite:**  \n \n* Account owner or admin permission.\n* Zoom Rooms version 4.0 or higher.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRLocationProfile","parameters":[{"name":"locationId","in":"path","description":"Unique identifier of the location type. This can be retrieved using the [**List Zoom Room locations**](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRLocations) API (ID property in the response).","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Rooms Location Profile returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"address":{"type":"string","description":"Address","example":"California, USA"},"description":{"type":"string","description":"Description about the location.","example":"California, USA"},"name":{"type":"string","description":"Name of the location type.","example":"State"},"required_code_to_ext":{"type":"boolean","description":"Require code to exit out of your Zoom Rooms application to switch between other apps.\n","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"1-16 digit number or characters used to secure your Zoom Rooms application.","example":"975193018"},"support_email":{"type":"string","description":"The email address to be used for reporting Zoom Room issues.\n","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number to be used for reporting Zoom Room issues.\n","example":"18798769876"},"timezone":{"type":"string","description":"Timezone (only returned for location type - city).","example":"Asia/Shanghai"},"parent_location_id":{"type":"string","description":"The parent location id.","example":"_HaPEsvmRNmOL4xF9ODXdw"}}},"setup":{"type":"object","properties":{"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is true, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`.","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"When the background image is a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), this field will contain the `content_id`. When a background image has been directly uploaded, this field will be empty.\"","example":"zrd9DycNSxK6K4dEUS6z-g"},"download_url":{"type":"string","description":"The URL where the background image file may be downloaded. This URL will be expire according to the `download_url_ttl`.","example":"https://zoom.us/file/Sq2mdxqRQ9eq7wmD5TFD6g?jwt=eyJ0eXAiOiJKV1QiLCJrIjoiaHRlNU05dDciLCJ6bV9za20iOiJ6bV9vMm0iLCJhbGc"},"download_url_ttl":{"type":"integer","description":"The time to live of the download URL, in seconds. When this field is not present, the link will never expire.","example":3600}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.<br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4801` <br>\n Location not found: {locationId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:location:master"]}},"delete":{"tags":["Zoom Rooms Location"],"summary":"Delete a location","description":"Remove a location from the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account.\n\n**Prerequisites:**\n* Account owner or admin permissions.\n* Zoom Rooms Version 4.0 or higher  \n   \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:write:location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteAZRLocation","parameters":[{"name":"locationId","in":"path","description":"Unique identifier of the location type. This can be retrieved using the [**List Zoom Room locations**](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRLocations) (ID property in the response).","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**   \n\nLocation deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\n**Access restricted**.<br> <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4801` <br>\n Location does not exist: {0}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:write:location:master"]}},"patch":{"tags":["Zoom Rooms Location"],"summary":"Update Zoom Room location profile","description":"Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located.\n\n**Prerequisite:**  \n \n* Account owner or admin permission.\n* Zoom Rooms version 4.0 or higher.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZRLocationProfile","parameters":[{"name":"locationId","in":"path","description":"Unique Identifier of the location. This can be retrieved from the [**List Zoom Room locations**](https://developers.zoom.us/docs/zoom-rooms/apis/#operation/listZRLocations) API.","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"basic":{"type":"object","properties":{"address":{"type":"string","description":"Address. Can only be updated for Campus and Building.","example":"California, USA"},"description":{"type":"string","description":"Description about the location.","example":"Floor-7"},"name":{"type":"string","description":"Name of the location type.","example":"State"},"required_code_to_ext":{"type":"boolean","description":"Require code to exit out of your Zoom Rooms application to switch between other apps.\n","example":true},"room_passcode":{"maxLength":16,"minLength":1,"type":"string","description":"1-16 digit number or characters used to secure your Zoom Rooms application.","example":"975193018"},"support_email":{"type":"string","description":"The email address to be used for reporting Zoom Room issues.\n","format":"email","example":"contact-it@example.com"},"support_phone":{"type":"string","description":"The phone number to be used for reporting Zoom Room issues.\n","example":"18798769876"},"timezone":{"type":"string","description":"Timezone (can only be updated for location type - city).","example":"Asia/Shanghai"}}},"setup":{"type":"object","properties":{"apply_background_image_to_all_displays":{"type":"boolean","description":"Apply the same background image to all displays of the Zoom Room. If the value of the this field is `true`, the `background_image_info` object will only contain and only accept changes to the background image information of `zoom_rooms_display1`.","example":true},"background_image_info":{"type":"array","description":"The background image information for each display. If the value of the `apply_background_image_to_all_displays` field is `true`, this object will only accept changes to the background image information of `zoom_rooms_display1`.","items":{"type":"object","properties":{"display_id":{"type":"string","description":"The id of the display. The value can be one of the following:  \n \n`zoom_rooms_display1`: The display1 of the Zoom Room.  \n \n`zoom_rooms_display2`: The display2 of the Zoom Room.  \n \n`zoom_rooms_display3`: The display3 of the Zoom Room. \n \n`zoom_rooms_display4`: The display4 of the Zoom Room. \n \n`companion_whiteboard`: The display of the Companion Whiteboard. \n \n`companion_zoom_rooms`: The display of the Companion Zoom Room.\n","example":"zoom_rooms_display1","enum":["zoom_rooms_display1","zoom_rooms_display2","zoom_rooms_display3","zoom_rooms_display4","companion_whiteboard","companion_zoom_rooms"]},"content_id":{"type":"string","description":"To set the background image to a [background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListZoomRoomsbackgroundimagelibrarycontents) or [default Zoom Rooms background image library content item](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/ListDefaultZoomRoomsBackgroundImageLibrarycontents), set this field to a background image library content item's `content_id`. To reset the background, set the content_id to an empty string.","example":"LHMmOOYaRiOA5m5WZjXVPA"}}}}}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  Location profile updated successfully."},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:location:master"]}}},"/accounts/{accountId}/rooms/locations/{locationId}/location":{"put":{"tags":["Zoom Rooms Location"],"summary":"Change the assigned parent location","description":"An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread across various locations. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location.   \n   \n  For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of `parent_location_id` in the  request body.  \n   \n \n**Prerequisite:**  \n \n* Account owner or admin permission\n* Zoom Rooms version 4.0 or higher  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"changeParentLocation","parameters":[{"name":"locationId","in":"path","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent_location_id":{"type":"string","description":"Location ID of the new Parent Location under which you the child location will be positioned. This can be retrieved from the [**List Zoom Room locations**](/docs/api-reference/zoom-api/methods#operation/listZRLocations) API.","example":"49D7a0xPQvGQ2DCMZgSe7w"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nLocation assigned successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br> <br>\n**Error Code:** `300` <br>\n Invalid parent location id {parent_location_id}. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4801` <br>\n Location not found:{parent_location_id}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:location:master"]}}},"/accounts/{accountId}/rooms/locations/{locationId}/settings":{"get":{"tags":["Zoom Rooms Location"],"summary":"Get location settings","description":"Get information on meeting, alert, digital signage or scheduling display settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.      **Prerequisites:**   * Zoom Room licenses* Owner or Admin privileges on the Zoom Account.   \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:read:location_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getZRLocationSettings","parameters":[{"name":"locationId","in":"path","description":"Unique identifier of the location type. This can be retrieved using the [**List Zoom Room locations**](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/listZRLocations) (ID property in the response).","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"setting_type","in":"query","description":"The type of setting that you would like to retrieve.\n\n`alert`: Alert settings of the Zoom Rooms located in a specific location.\n \n`meeting`: Meeting settings of the Zoom Rooms located in a specific location.\n \n`signage`: Digital Signage settings of the Zoom Rooms located in a specific location.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Rooms located in a specific location.","required":true,"style":"form","schema":{"type":"string","example":"meeting","default":"meeting"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` **OK**  \n \nZoom Room location settings returned successfully.","content":{"application/json":{"schema":{"oneOf":[{"title":"index0","type":"object","properties":{"meeting_security":{"type":"object","properties":{"encryption_type":{"type":"string","description":"Specifies whether enhanced encryption or [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) is being used when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**.   \n   \n The value of this field can be one of the following:  \n \n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Allows use of end-to-end encryption for meetings. If set to `true`, the encryption type is specified in `encryption_type` field.","example":true},"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with one security option. Require that all meetings are secured with one of the following security options: a passcode, Waiting Room, or &quot;Only authenticated users can join meetings&quot;. If no security option is enabled, Zoom will secure all meetings with Waiting Room.","example":true}}},"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_accept_incoming_call_and_fecc":{"type":"boolean","description":"Automatically accept incoming calls made from other Zoom Rooms or contacts in your account. Enabling this setting will also automatically allow far-end camera control.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"hide_self_view":{"type":"boolean","description":"If enabled, you will not see your own video but other people in the meeting can still see your video.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"lock_speaker_volume_control":{"type":"boolean","description":"Lock speaker volume control on controller.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"show_non_video_participants":{"type":"boolean","description":"When enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Rooms display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"start_airplay_mirroring":{"type":"boolean","description":"Allow users to share content via Apple Screen Mirroring (called Airplay on iOS 11 or earlier) in Zoom Rooms","example":true},"start_hdmi_content_share_manualy":{"type":"boolean","description":"Disable automatic detection and enable manual content sharing from a device to a Zoom Room. Learn more [here](https://support.zoom.us/hc/en-us/articles/201504265-Wired-HDMI-Screen-Share-via-Capture-Device).\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"voice_commands":{"type":"boolean","description":"Enable [voice commands](https://support.zoom.us/hc/en-us/articles/115000527983-Voice-Command-with-Zoom-Rooms) with Zoom Rooms.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true},"incoming_meeting_request":{"type":"object","properties":{"automatically_accept_incoming_meeting_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming meeting requests (calls), such as being invited to a meeting in progress","example":true},"automatically_unmute":{"type":"boolean","description":"If enabled, the Zoom Room will automatically unmute after it automatically accepts the incoming meeting request and joins the meeting","example":true}}},"automatically_accept_far_end_camera_control_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming far end camera control (FECC) requests from other Zoom clients received during a Zoom meeting","example":true}}}}},{"title":"index1","type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","description":"Display or hide banner room name.","example":true},"banner_sharing_key":{"type":"boolean","description":"Display or hide banner sharing key.","example":true},"banner_time":{"type":"boolean","description":"Display or hide time in the banner.","example":true}},"description":"Specifies the elements that you want to display in the top banner."},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. The value of this field indicates the duration in minutes.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. The value of this field indicates the duration in minutes.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Indicates whether digital signage is on or off,](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"standard"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"update","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"Duration for how long the content will be displayed.","example":65},"id":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"},"name":{"type":"string","description":"Name of the content.","example":"content name"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content name"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess Restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4801` <br>\n Location not found: {locationId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:read:location_settings:master"]}},"patch":{"tags":["Zoom Rooms Location"],"summary":"Update location settings","description":"Update meeting, alert, digital signage or scheduling display 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.      \n\n**Prerequisites:**   * Zoom Room licenses* Owner or Admin privileges on the Zoom Account.   \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `room:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_rooms:update:location_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"updateZRLocationSettings","parameters":[{"name":"locationId","in":"path","description":"Unique identifier of the location type. This can be retrieved using the [**List Zoom Room locations**](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationSettings) (ID property in the response).","required":true,"style":"simple","schema":{"type":"string","example":"49D7a0xPQvGQ2DCMZgSe7w"}},{"name":"setting_type","in":"query","description":"The type of setting that you would like to update.  \n\n`alert`: Alert settings of the Zoom Rooms located in a specific location.\n \n`meeting`: Meeting settings of the Zoom Rooms located in a specific location.\n \n`signage`: Digital Signage settings of the Zoom Rooms located in a specific location.\n\n`scheduling_display`: Scheduling Display settings of the Zoom Rooms located in a specific location.","required":true,"style":"form","schema":{"type":"string","example":"meeting","default":"meeting"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"index0","type":"object","properties":{"meeting_security":{"type":"object","properties":{"encryption_type":{"type":"string","description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**.   \n   \n The value of this field can be one of the following:  \n \n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option.   \n \n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Allow use of end-to-end encryption for meetings. If set to `true`, you can specify the encryption type in `encryption_type` field.","example":true},"auto_security":{"type":"boolean","description":"Whether to require that all meetings are secured with one security option. Require that all meetings are secured with one of the following security options: a passcode, Waiting Room, or &quot;Only authenticated users can join meetings&quot;. If no security option is enabled, Zoom will secure all meetings with Waiting Room.","example":true}}},"zoom_rooms":{"type":"object","properties":{"allow_multiple_content_sharing":{"type":"boolean","description":"Enable multiple participants to [share content simultaneously](https://support.zoom.us/hc/en-us/articles/360017767812-Sharing-Multiple-Screens-in-a-Zoom-Room) by default.","example":true},"audio_device_daily_auto_test":{"type":"boolean","description":"Enable [automated audio test](https://support.zoom.us/hc/en-us/articles/360000319683-Zoom-Rooms-Daily-Audio-Testing) to ensure high quality audio.","example":true},"auto_accept_incoming_call_and_fecc":{"type":"boolean","description":"Automatically accept incoming calls made from other Zoom Rooms or contacts in your account. Enabling this setting will also automatically allow far-end camera control.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"auto_direct_sharing":{"type":"boolean","description":"Enable participants in a Zoom Room to share their laptop screen on the Zoom Room TV without entering a meeting ID or sharing code.","example":true},"auto_start_scheduled_meeting":{"type":"boolean","description":"Automatically start scheduled meetings according to the start time listed on the calendar associated with the room. A meeting alert will appear 10 minutes prior to the scheduled time on the TV.","example":true},"auto_stop_scheduled_meeting":{"type":"boolean","description":"Automatically stop the meeting at the end time as scheduled and listed in the calendar associated with the room. ","example":true},"count_attendees_number_in_room":{"type":"boolean","description":"Use facial detection technology to [determine and display the attendees count](https://support.zoom.us/hc/en-us/articles/360031027111-Count-Attendees-in-Zoom-Rooms) after meetings on Dashboard.\n","example":true},"display_feedback_survey":{"type":"boolean","description":"Display a [survey](https://support.zoom.us/hc/en-us/articles/214193146-End-of-Meeting-Attendee-Feedback) at the end of each meeting regarding the audio and video quality on the Zoom Rooms Controller.","example":true},"display_meeting_list":{"type":"boolean","description":" Show the same information on the TV that is shown on the controller.","example":true},"display_top_banner":{"type":"boolean","description":"Allow to display room name, time and sharing key on the top portion of TV.","example":true},"encrypt_shared_screen_content":{"type":"boolean","description":"Encrypt screen and content shared in meetings.","example":true},"hide_id_for_private_meeting":{"type":"boolean","description":"If enabled, the meeting host and meeting ID (in addition to the meeting topic) are hidden from the Zoom Rooms display for private meetings. This affects meetings that were originally scheduled as private, as well as public meetings that were transformed to private.","example":true},"hide_self_view":{"type":"boolean","description":"If enabled, you will not see your own video but other people in the meeting can still see your video.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"lock_speaker_volume_control":{"type":"boolean","description":"Lock speaker volume control on controller.\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"send_whiteboard_to_internal_contact_only":{"type":"boolean","description":"Restrict[ sending Whiteboard sessions](https://support.zoom.us/hc/en-us/articles/115004797286-Using-the-Whiteboard-in-Zoom-Rooms-for-Touch#h_781274b3-5237-4320-8826-be2120b00e21) to contacts or internal users only.","example":true},"show_alert_before_meeting":{"type":"boolean","description":"If enabled, the upcoming meeting alert message will be shown on the TV display. The value of the `upcoming_meeting_alert` field should be set to `true` to use this field. ","example":true},"show_call_history_in_room":{"type":"boolean","description":"Allow users to see call history of joined meetings and phone calls from the Zoom Rooms controller.\n","example":true},"show_contact_list_on_controller":{"type":"boolean","description":"If enabled, you can invite participants from the contact list during a meeting or when starting a meeting","example":true},"show_non_video_participants":{"type":"boolean","description":"When enabled, meeting participants that are audio only or have their video turned off will also be shown on the Zoom Rooms display by default.","example":true},"start_airplay_manually":{"type":"boolean","description":"Require the AirPlay service to be [started by an administrator](https://support.zoom.us/hc/en-us/articles/204726885-Screen-Share-Using-Airplay-Mirroring#h_a342ad38-4e46-47a8-a1d9-cded3b144b39) rather than always being available.","example":true},"start_airplay_mirroring":{"type":"boolean","description":"Allow users to share content via Apple Screen Mirroring (called Airplay on iOS 11 or earlier) in Zoom Rooms","example":true},"start_hdmi_content_share_manualy":{"type":"boolean","description":"Disable automatic detection and enable manual content sharing from a device to a Zoom Room. Learn more [here](https://support.zoom.us/hc/en-us/articles/201504265-Wired-HDMI-Screen-Share-via-Capture-Device).\n\nThis setting is returned only for location type - &quot;country&quot;.","example":true},"support_join_3rd_party_meeting":{"type":"boolean","description":"Integrate with Skype for Business, GoToMeeting, or WebEx and show the meeting dial-in button on the meeting list tab for Zoom Rooms Controllers.","example":true},"transform_meeting_to_private":{"type":"boolean","description":"If enabled, all meetings in this room will be treated as [private meetings](https://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings), and the Zoom Room will display &quot;Your Name's Meeting&quot; instead of the real meeting topic.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"If enabled, a reminder will display 10 minutes prior to the next scheduled meeting on the controller.","example":true},"voice_commands":{"type":"boolean","description":"Enable [voice commands](https://support.zoom.us/hc/en-us/articles/115000527983-Voice-Command-with-Zoom-Rooms) with Zoom Rooms.","example":true},"weekly_system_restart":{"type":"boolean","description":"[Restart](https://support.zoom.us/hc/en-us/articles/205418949-Zoom-Rooms-Weekly-System-Restart) the Zoom Rooms computer and controller once a week.","example":true},"incoming_meeting_request":{"type":"object","properties":{"automatically_accept_incoming_meeting_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming meeting requests (calls), such as being invited to a meeting in progress","example":true},"automatically_unmute":{"type":"boolean","description":"If enabled, the Zoom Room will automatically unmute after it automatically accepts the incoming meeting request and joins the meeting","example":true}}},"automatically_accept_far_end_camera_control_request":{"type":"boolean","description":"If enabled, the Zoom Room will automatically accept incoming far end camera control (FECC) requests from other Zoom clients received during a Zoom meeting","example":true}}}}},{"title":"index1","type":"object","properties":{"client_alert":{"type":"object","properties":{"detect_bluetooth_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth microphone.","example":true},"detect_bluetooth_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a bluetooth speaker.","example":true},"detect_camera_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a camera.","example":true},"detect_microphone_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with microphone.","example":true},"detect_speaker_error_alert":{"type":"boolean","description":"Display an alert message when an issue is detected with a speaker.","example":true},"cpu_usage_high_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display when CPU usage is above 90%.","example":true},"network_unstable_detected_notification_on_zr_display":{"type":"boolean","description":"Display a notification message on the Zoom Room display low bandwidth network is detected","example":true}},"description":"The Client Alert Settings section includes alerts that display on the TV screen of the Zoom Room. Disable these settings if you have deliberately disconnected one or more peripheral devices or have never enabled them. "},"digital_signage":{"type":"object","properties":{"banner":{"type":"object","properties":{"banner_room_name":{"type":"boolean","example":true},"banner_sharing_key":{"type":"boolean","example":true},"banner_time":{"type":"boolean","example":true}}},"display_period":{"type":"object","properties":{"start_displaying_content":{"type":"integer","description":"Start displaying digital signage content after certain duration after the meeting ends. Specify the value of the duration in minutes in this field.","example":1},"stop_displaying_content":{"type":"integer","description":"Stop displaying content {certain_duration} before a meeting is scheduled to begin. Specify the value of duration in minutes in this field.","example":1}},"description":"Display period object lets you define the number of minutes before or after the scheduled meeting time you would like the content to display."},"enable_digital_signage":{"type":"boolean","description":"[Enable or disable digital signage](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_767fbb33-82a8-45a8-8392-a1bfa9687edd).   \n \n`true`: enable  \n  `false`: disable","example":true},"layout":{"type":"string","description":"Set the [layout](https://support.zoom.us/hc/en-us/articles/360000030683-Zoom-Rooms-digital-signage#h_4e25ddf3-8f97-4957-8f8b-99725f940fa7). The value of this field can be either `standard` or `video_content`.\n\n`standard`: Standard Center  \n \n`video_content`: Video + Content","example":"standard"},"mute":{"type":"boolean","description":"Sound of all contents will be muted if the value of this field is set to `true`.","example":true},"play_list":{"maxItems":2,"type":"array","description":"Content list.","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content list. The value can be one of the following:  \n \n`add`: Add another content list.  \n \n`update`: Update existing content list.  \n \n`delete`: Delete content list.\n","example":"update","enum":["add","update","delete"]},"contents":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"Specify an action for the content in the content list. The value can be one of the following:  \n \n`add`: Add another content to the content list.  \n \n`update`: Update existing content's information in the content list.  \n \n`delete`: Delete content from the content list.\n\n","example":"update"},"content_id":{"type":"string","description":"Content Id.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"duration":{"type":"integer","description":"By default each content is display for 5 seconds. Using this field, specify how long you would like to display the content.","example":65},"id":{"type":"string","description":"Unique identifier of the content. This field is only required if you would like to remove or update the content information.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content.","example":"content name"},"order":{"type":"integer","description":"Order of the content in the display.","example":1}},"description":"Content list."}},"end_time":{"type":"string","description":"Specify the display end time for the content list in GMT.","example":"2021-03-18T05:41:36Z"},"id":{"type":"string","description":"Unique identifier of the content list. This field is only required if you would like to remove or update the content list.","example":"blKfsfQ-QSW7V_LPjZrIdg"},"name":{"type":"string","description":"Name of the content list.","example":"content list"},"start_time":{"type":"string","description":"Specify the display start time for the content list in GMT.","example":"2021-03-18T05:41:36Z"}}}}}},"notification":{"type":"object","properties":{"audio_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result meets usability threshold.","example":true},"audio_not_meet_usability_threshold":{"type":"boolean","description":"Send an alert when the audio echo test result does not meet usability threshold.","example":true},"battery_is_charging":{"type":"boolean","description":"Send an alert when the battery starts charging.","example":true},"battery_low_and_not_charging":{"type":"boolean","description":"Send an alert when the battery of the controller or the scheduling display is low (at 20%) and is not being charged.","example":true},"battery_percentage":{"type":"string","description":"Specify a percentage so that an alert is sent when the battery is less than the {battery_percentage} that you specified.","example":"90"},"controller_scheduling_disconnected":{"type":"boolean","description":"Send an alert when the connection to the Controller or Scheduling Display cannot be detected.","example":true},"controller_scheduling_reconnected":{"type":"boolean","description":"Send an alert when the Controller or Scheduling Display can be detected again.","example":true},"cpu_usage_high_detected":{"type":"boolean","description":"Send an alert when CPU usage is above 90%.","example":true},"mic_speaker_camera_disconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is disconnected in the Zoom Room.","example":true},"mic_speaker_camera_reconnected":{"type":"boolean","description":"Send an alert when the mic, speaker or camera is reconnected.","example":true},"network_unstable_detected":{"type":"boolean","description":"Send an alert when low bandwidth network is detected","example":true},"sip_registration_failed":{"type":"boolean","description":"Send an alert when SIP registration stops working. ","example":true},"sip_registration_re_enabled":{"type":"boolean","description":"Send an alert after the SIP registration is re-enabled.","example":true},"zoom_room_come_back_online":{"type":"boolean","description":"Send an alert when the Zoom Room is online after previously being offline.","example":true},"zoom_room_display_disconnected":{"type":"boolean","description":"Send an alert when the TV display is disconnected","example":true},"zoom_room_offline":{"type":"boolean","description":"Send an alert when the machine hosting the Zoom Room application has a network issue or cannot connect with the Controller.","example":true}},"description":"[Notifications Settings](https://support.zoom.us/hc/en-us/articles/205394099-Zoom-Room-Alerts#h_b430b5f2-5150-4522-9c96-c77f22ab70bc) includes the circumstances in which the room sends an email alert to the support team to notify them of a potentially urgent issue. These issues can affect the operation of the room, but do not display on the TV screen. The email alert is sent to the email address specified in the Notification Email Recipients section. "},"scheduling_display":{"type":"object","properties":{"instant_room_reservation":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform an instant room reservation on the device.","example":true},"reserve_other_rooms":{"type":"object","properties":{"allow_to_reserve_other_rooms":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will allow a user to perform instant room reservations of other rooms on the device.","example":true},"location_types":{"type":"string","description":"The Zoom Room Scheduling Display will allow a user to find other rooms to reserve in the same parent Zoom Rooms Location Hierarchy Location as this device, and higher Location levels if so configured. Use the API [Get Zoom Room Location Structure](https://developers.zoom.us/docs/api/rest/reference/zoom-rooms/methods/#operation/getZRLocationStructure) to determine valid Location levels.","example":"floor","enum":["city","campus","building","floor"]}},"description":"Contains settings that allows Zoom Room Scheduling Display to reserve other Zoom Rooms."},"set_scheduling_display_background_image_to_zoom_room_background":{"type":"boolean","description":"If enabled, the Zoom Room Scheduling Display will use the same background image as the Zoom Room. Note: Some Zoom Rooms Scheduling displays use a different display aspect ratio than standard 16:9; the background image will be scaled to fit the Scheduling Display's display, with any excess cropped.","example":true},"home_screen_theme":{"type":"string","description":"The Zoom Room Scheduling Display UI theme.","example":"compact","enum":["standard","compact"]},"home_screen_qr_code_url":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for a QR code to be displayed. You may optionally provide a URL which Zoom will use to automatically generate the corresponding QR code image. If you provide a URL that exceeds 100 characters in total length, Zoom will automatically use the Zoom URL shortening service to generate a shortened URL that will redirect to your actual URL; the URL is shortened to increase QR code scan reliability. This setting has no effect if the home screen theme is \"standard\".","example":"https://example.com"},"home_screen_qr_code_supporting_text":{"type":"string","description":"If the Zoom Rooms Scheduling Display home screen theme is \"compact\", a space is reserved for additional text to appear adjacent to the space reserved for a QR code. This setting has no effect if the home screen theme is \"standard\".","example":"Scan to reserve"}},"description":"Scheduling Display Settings section includes performing Zoom Room reservations and setting the home screen theme on the Scheduling Display device."}}}]}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**  \n \nLocation settings updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4801` <br>\n Location not found: {locationId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Read","SubAccount:Edit"],"x-macro-scopes":["room:master"],"x-granular-scopes":["zoom_rooms:update:location_settings:master"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"scheme":"bearer","type":"http"}}},"tags":[{"name":"Zoom Rooms"},{"name":"Zoom Rooms Account"},{"name":"Zoom Rooms Content"},{"name":"Zoom Rooms Devices"},{"name":"Zoom Rooms Location"}]}