Update Calendar Resource

PUT 
/calendars/resources/:resourceType/:id

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Update calendar resource by ID (Services V1)

Request

Version stringrequired

API Version

Available options2021-07-28

resourceType stringrequired

Calendar Resource Type

Available optionsequipmentsrooms

id stringrequired

Calendar Resource ID

application/json

application/json

Body

Bodyrequired

locationIdstring

Location ID

namestring

Name of the calendar resource

descriptionstring

Description of the calendar resource

quantitynumber

Quantity of the equipment.

outOfServicenumber

Quantity of the out of service equipment.

capacitynumber

Capacity of the room.

calendarIdsstring[]

Service calendar IDs to be mapped with the resource.

One equipment can only be mapped with one service calendar.

One room can be mapped with multiple service calendars.

Possible values: <= 100

isActiveboolean

Whether the resource is active

Example (auto)

{
  "locationId": "ocQHyuzHvysMo5N5VsXc",
  "name": "Projector",
  "description": "Main conference room projector",
  "quantity": 5,
  "outOfService": 1,
  "capacity": 20,
  "calendarIds": [
    "Jsj0xnlDDjw0SuvX1J13"
  ],
  "isActive": true
}

application/json

Calendar resource updated

application/json

Schema

Schema

locationIdstringrequired

Location ID of the resource

namestringrequired

Name of the resource

resourceTypestringrequired
Type of the calendar resource
Available optionsequipmentsrooms
isActivebooleanrequired

Whether the resource is active

descriptionstring

Description of the resource

quantitynumber

Quantity of the resource

outOfServicenumber

Indicates if the resource is out of service

capacitynumber

Capacity of the resource

Example (auto)

{
  "locationId": "ocQHyuzHvysMo5N5VsXc",
  "name": "yoga room",
  "resourceType": "rooms",
  "isActive": true,
  "description": "Spacious yoga studio",
  "quantity": 3,
  "outOfService": 0,
  "capacity": 85
}