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:

Scope: room:write:admin

Servers

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.

If the calendar integration being used is Microsoft Exchange, the value for this field can be retrieved by using Microsoft's FindItem Operation and referring to the Id field of the ItemId Element included in the operation response.

If the Google calendar integration was used for this event, the event_id can be retrieved by calling Google's Events:list API and referring to the "id" field included in the events resource.

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:

  • zoomroom.check_in
  • zoomroom.check_out

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.