Update a Meeting Room

Update a specific meeting room.

Request URL

PUT {base_url}/services/openapi/v1.0/room/room_update

Request parameters

Body parameters

Important: It is recommended to include all the parameters in an update request, as parameters not included in the request might be set to NULL or reset to default settings.
Parameter Required Type Description
roomId Yes Long The ID of the meeting room.
Note: You can query the room ID using the Query Multiple Meeting Rooms interface.
name Yes String The name of the meeting room.
buildingName Yes String The name of the floor where the meeting room is located.
floorName No String The name of the building where the meeting room is located.
capacity No Integer The maximum number of people the meeting room can accommodate.
facilityName No String The name of the available facilities in the meeting room.
Note: Use a comma to separate multiple facilities. For example, "Projector,Laser Pointer".
type Yes String Meeting room type.
  • common: Regular Meeting Room.
  • approval: Request-only Room.
  • special: Dedicated Meeting Room.
bookingMemberIds No Array <Long> The member ID(s) of the user(s) with the permission to book the meeting room.
Note:
  • When type is set to common or approval, either the bookingMemberIds or bookingGroupIds parameter is required.
  • You can query the user's member ID using the Query Multiple Users interface.
  • Use a comma to separate multiple IDs. For example, [1001,1002].
bookingGroupIds No Array <Long> The ID(s) of the user group(s) with the permission to book the meeting room.
Note:
  • When type is set to common or approval, either the bookingMemberIds or bookingGroupIds parameter is required.
  • You can query the user group's ID using the Query Multiple User Groups.
  • Use a comma to separate multiple IDs. For example, [1001,1002].
approvalMemberIds No Array <Long> The member ID(s) of the user(s) that have the privilege to approve reservation requests for the meeting room.
Note:
  • When type is set to approval, either the approvalMemberIds or approvalGroupIds parameter is required.
  • You can query the user's member ID using the Query Multiple Users interface.
  • Use a comma to separate multiple IDs. For example, [1001,1002].
approvalGroupIds No Array <Long> The ID(s) of the user group(s) that have the privilege to approve reservation requests for the meeting room.
Note:
  • When type is set to approval, either the approvalMemberIds or approvalGroupIds parameter is required.
  • You can query the user group's ID using the Query Multiple User Groups.
  • Use a comma to separate multiple IDs. For example, [1001,1002].
remark No String Remark.
restrictInWorkingHours No Boolean Whether to restrict the meeting room booking to the company working hours.
Valid value:
  • true: Enabled. The meeting room can only be booked during working hours.
  • false: Disabled.
maxDuration No Integer The maximum duration that the meeting room can be reserved for (Unit: minute).

Valid range: 60 - 480.

Note: If you don't want to limit the reservation duration of the meeting room, set the parameter to -1.
bookingWindow No Integer How far in advance can the meeting room be booked (Unit: day).

Valid range: 1 - 365.
repeatBooking No Boolean Whether to enable recurring booking for the meeting room.
Valid value:
  • true: Enabled. Users can schedule recurring meeting room reservations.
  • false: Disabled.
checkInRequired No Boolean Whether check-in is required for the meeting room reservations.
Valid value:
  • true: Required. Users need to check in to confirm their reservations.
  • false: Not required.
checkInWindow No Integer How far in advance can users check in to the meeting room reservation before the meeting starts.

Valid range: 5 - 15.
checkInPermission No String Who can check in to the meeting room reservations.
Valid value:
  • ONLY_ORGANIZER: Organizer only.
  • ANY_PARTICIPANTS: Organizer or any participants.
checkInCount No Boolean Whether to enable meeting participant check-in for attendee counting.
Valid value:
  • true: Enabled. Meeting participants can check in to a meeting. The system will record the actual attendees for the meeting.
  • false: Disabled.
notcheckInAutoRelease No Boolean Whether to auto release the meeting room if no check-in occurs within the check-in timeout.
Valid value:
  • true: Enabled. When no one check in to the meeting and it reaches the check-in timeout, the meeting room will be released automatically.
  • false: Disabled.
checkInTimeout No Integer Check-in timeout (Unit: minute).

Valid range: 5 - 30.
endPermission No String Who can end the meeting.
Valid value:
  • ONLY_ORGANIZER: Organizer only.
  • ANY_PARTICIPANTS: Organizer or any participants.
deviceNames No String The name of the smart devices to be associated with the meeting room.
Note: Use a comma to separate multiple devices. For example, "visitor-screen,LoRagateway".
displayBooking No Boolean Whether user can book the meeting room on its associated Room Display.

Valid value:

  • true: Enabled. Users can book the meeting room on the associated Room Display.
  • false: Disabled.
unoccupiedAutoRelease No Boolean Whether to auto release an in-use meeting room when the associated People Counting Sensor continuously detects the room is empty within the unoccupied auto-release timeout.

Valid value:

  • true: Enabled.
  • false: Disabled.
unoccupiedDuration No Integer Meeting room unoccupied auto-release timeout (Unit: minute).

Valid range: 15 - 30.
lightOnCheckedIn No Boolean Whether the associated Smart Switch will automatically turn on the lights in the meeting room when users check in.
Valid value:
  • true: Enabled.
  • false: Disabled.
lightOffEnded No Boolean Whether the associated Smart Switch will automatically turn off the lights in the meeting room when a meeting ends.
Valid value:
  • true: Enabled.
  • false: Disabled.
lightOnOffWork No Boolean Whether the associated Smart Switch will automatically turn off the lights in the meeting room during non-working hours.
Valid value:
  • true: Enabled.
  • false: Disabled.
accessControl No Boolean Whether to enable access control for the meeting room.
Note: To implement access control of a meeting room, make sure that you have connected the meeting room's associated Room Display with an access control devices.

Valid value:

  • true: Enabled. Only users with access permissions can enter the meeting room.
  • false: Disabled.

Response parameters

Parameter Type Description
data Object <Details> The detailed information.
status String The result of the request.
  • Success
  • Failed
requestId String The ID of the request, which can be used to quickly locate the request.
Details
Parameter Type Description
roomId Long The ID of the meeting room.

Example

Request example

Update a meeting room:
  • Meeting room ID: 3101.
  • Add a facility Laser Pointer in a meeting room.
Important: It is recommended to include all the parameters in an update request, as parameters not included in the request might be set to NULL or reset to default settings.
PUT /services/openapi/v1.0/room/room_update HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6IjEyNGFmMGI3LWNjMzgtNGEwZC1hZWIwLTEyNWYxNzIwZWRmYyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTc2NDMwNywiZXhwX2luIjo4NjM5OX0.qJg3rOhz5rPtXKyO0mVFeL_TmHExNzhYU2g-1XIOBzo
Content-Type: application/json

{
    "roomId":3101,
    "name": "Test Meeting Room",
    "buildingName": "Yeastar",
    "floorName":"2F",
    "capacity":20,
    "facilityName": "Projector,Laser Pointer",
    "type": "approval",
    "bookingMemberIds": [3084,466],
    "approvalMemberIds":[3084],
    "remark": "For Test",
    "restrictInWorkingHours":true,
    "minDuration":30,
    "maxDuration": 300,
    "bookingWindow":365,
    "repeatBooking":true,
    "checkInWindow":15,
    "checkInPermission":"ANY_PARTICIPANTS",
    "checkInCount":true,
    "notcheckInAutoRelease":true,
    "checkInTimeout":15,
    "endPermission": "ANY_PARTICIPANTS",
    "deviceNames": "visitor-screen,LoRagateway",
    "displayBooking":true,
    "unoccupiedAutoRelease":true,
    "unoccupiedDuration":15,
    "lightOnCheckedIn":true,
    "lightOffEnded":true,
    "lightOnOffWork":true,
    "accessControl":true
}

Response example

HTTP/1.1 200 OK
{
    "data": {
        "roomId": 3101
    },
    "status": "Success",
    "requestId": "04a181989cce96b4a5c9abe0af051493"
}