PATCH /rooms/{id}/events
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 gets released from the scheduled meeting and will be made available for others to use. Learn more from the Using the Zoom Rooms check-in feature guide.
Prerequisites:
- Zoom Rooms must have been set up for use for the account and must be online.
- You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.
Scope: room:write:admin
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Room ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
params |
Object | No | |
params.event_id |
String | Yes |
Unique Identifier of the calendar event associated with the Zoom Room. |
params.change_key |
String | No |
This field is required only for Microsoft Exchange or Office 365 calendar. The change key represents the specific version of the calendar item and can be retrieved by using Microsoft's FindItem Operation and referring to the ChangeKey field of the ItemId Element included in the operation response. |
params.calendar_id |
String | No |
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 and referring to the "id" field included in the calendarList resource. |
params.resource_email |
String | No |
This field is only required for Microsoft Exchange / Office 365 Calendar. It is the resource mailbox associated with the calendar. |
method |
String | No |
The value of this field can be one of the following:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.