Skip to main content
PUT
Update Resource
Updates an existing Resource record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Resource-Edit role.

Enums

Request Body

Required Fields

integer
required
The Id of the Resource record to update.
integer
required
ID of the location where this resource is located..
string
required
Display name of the resource (e.g., ‘Board Room A’, ‘Phone Booth 3’)..
integer
required
Built-in resource category used for system behaviour (e.g., MeetingRoom, HotDesk, PhoneBooth). AI agents use this value to guide customers asking for specific type of services to the right resource. Distinct from the custom ResourceType..
integer
required
ID of the resource type assigned to this resource. The resource inherits every applicable booking rate (ExtraService) whose ResourceTypes relationship includes this type; use a different resource type when a resource needs a different set of rates..
integer
required
Sort position when listing resources. Lower values appear first..
integer
required
How the cancellation fee is calculated: Absolute (fixed amount) or Percentage (of booking cost)..

Optional Fields

string
Free-text description shown to users when viewing the resource details..
string
URL of a new file to upload as the picture.
boolean
Set to true to remove the current picture file.
string
Custom HTML or text included in booking confirmation emails for this resource..
boolean
Whether the resource is published and bookable by end users from the Members Portal and the app. Hidden resources can still be booked by admins..
boolean
When true, bookings for this resource are held as pending until an admin user approves them..
string
Optional grouping label used to cluster related resources together in the UI (e.g., ‘Floor 2’)..
boolean
Amenity flag: resource has a projector..
boolean
Amenity flag: resource has internet access..
boolean
Amenity flag: resource has a conference phone..
boolean
Amenity flag: resource has a standard phone..
boolean
Amenity flag: resource has a whiteboard..
boolean
Amenity flag: resource has a large display..
boolean
Amenity flag: catering is available for this resource..
boolean
Amenity flag: tea and coffee are available..
boolean
Amenity flag: drinks are available..
boolean
Amenity flag: resource has a security lock..
boolean
Amenity flag: resource has CCTV coverage..
boolean
Amenity flag: resource has a voice recorder..
boolean
Amenity flag: resource has air conditioning..
boolean
Amenity flag: resource has heating..
boolean
Amenity flag: resource has natural light..
boolean
Amenity flag: resource has a standing desk..
boolean
Amenity flag: resource is located in a quiet zone..
boolean
Amenity flag: resource has a wireless charger..
boolean
Amenity flag: resource has a privacy screen..
boolean
Amenity flag: resource is soundproof..
boolean
Amenity flag: resource has video conferencing equipment..
boolean
Amenity flag: resource has a dual display screen..
boolean
Amenity flag: resource has a display screen..
boolean
Amenity flag: resource has wireless presentation capabilities..
boolean
Amenity flag: resource has a PA system..
boolean
Amenity flag: resource has a desktop monitor..
boolean
Amenity flag: resource has a flip chart..
boolean
Amenity flag: resource has secure storage..
boolean
When true, overlapping bookings are permitted and Allocation controls the maximum number of concurrent bookings. When false, only one booking at a time is allowed and Allocation is purely informational (physical capacity)..
integer
When AllowMultipleBookings is true, this is the maximum number of overlapping bookings accepted. When AllowMultipleBookings is false, this is informational physical capacity (e.g., number of seats) and does not affect booking limits..
boolean
When true, the total number of visitors added to a booking cannot exceed the Allocation capacity..
number
Maximum number of hours in advance a booking can be made for this resource. Null means no limit..
number
Minimum lead time in hours required before a booking can start. Negative values allow bookings after the start time..
integer
Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..
integer
Fixed interval in minutes used for booking start times, end times, and durations. Must be a non-zero multiple of 15 minutes..
integer
Required gap in minutes between bookings made by the same customer or team for this resource..
integer
Required gap in minutes before the same customer or team can book this or any other resource..
integer
Required gap in minutes between all consecutive bookings for this resource, regardless of customer..
integer
Maximum allowed duration for a single booking on this resource, in minutes..
integer
Minimum allowed duration for a single booking on this resource, in minutes..
integer[]
List of tariffs (pricing plans) linked to this resource. Restricts bookings to customers on specific pricing plans..
integer[]
IDs added to the Tariffs relationship..
integer[]
IDs removed from the Tariffs relationship..
integer[]
List of teams linked to this resource. Restricts bookings to members of specific teams..
integer[]
IDs added to the Teams relationship..
integer[]
IDs removed from the Teams relationship..
string
Comma-separated list of shifts defining when the resource is available. Each shift uses the format ‘NAME: START_TIME->END_TIME’ where NAME is a descriptive label (cannot contain colons), and times are in 24-hour HH:MM format. Example: ‘FULL DAY (9AM - 6PM): 09:00->18:00, MORNING (9AM - 1PM): 09:00->13:00, AFTERNOON (1PM - 6PM): 13:00->18:00’. The shift name must NOT contain ’:’ as it breaks parsing..
integer[]
List of linked resources. Used to associate resources that make each other unavailable. For example, a larger room that divided and booked individually would be represented as three resources: A (linked to C), B (linked to C) and C (linked to A+B).
integer[]
IDs added to the LinkedResources relationship..
integer[]
IDs removed from the LinkedResources relationship..
string
ID of the google calendar associated with this record.
string
ID of the kisi group associated with this record.
string
ID of the access control group associated with this record (deprecated).
number
GPS longitude coordinate of the resource’s physical location..
number
GPS latitude coordinate of the resource’s physical location..
boolean
When true, this resource does not appear on the booking calendar view in the admin panel. Use ‘Visible’ to control if the resource is visible in the Members Portal and the App.
boolean
When true, the resource is archived and hidden from all views. It cannot be booked..
boolean
When true, bookings for this resource use the location’s shared Zoom account to create virtual meetings..
string
The zoom access token value for this resource.
string
The zoom refresh token value for this resource.
string
Zoom user ID used to host virtual meetings when UseSharedZoomAccount is false..
string
Timestamp of the last cleaning event for this resource..
string
ID of the office365 calendar associated with this record.
string
Comma-separated string of linked resource IDs (read-only view of LinkedResources)..
boolean
When true, only contacts (customers without an active contract for a plan) can book this resource..
boolean
When true, only active members (customers with an active contract for a plan) can book this resource..
boolean
When true, only customers with a home location set to the resource’s location can book this resource..
integer[]
List of booking availability exceptions (date ranges when this resource is unavailable or has special availability rules)..
integer[]
IDs added to the BookingAvailabilityExceptions relationship..
integer[]
IDs removed from the BookingAvailabilityExceptions relationship..
integer
ID of the product representing the cancellation fee linked to this resource.
boolean
When true, a fee is charged for late cancellations (past the LateCancellationLimit)..
number
Fixed cancellation fee amount. Used when CancellationFeeType is Absolute..
number
Cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage..
integer
Maximum number of occurrences allowed when creating a recurring booking for this resource..
integer
Maximum time span (in months) over which a recurring booking series can extend..

Children

object[]
The days and times this resource is available for booking. The year, month and day component of FromTime/ToTime is always 1976-01-01.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the resource was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response