Resources
Create Resource
Create a new Resource record.
POST
Create Resource
A Resource represents any bookable item in a coworking or flex-space location — meeting rooms, event spaces, phone booths, hot desks, private offices, storage units, labs, kitchens, and more. Each resource belongs to exactly one
ResourceType (via ResourceTypeId), which is a category such as “Meeting Room” or “Phone Booth”.
Resource → ResourceType → ExtraService (booking rates): Pricing is not set directly on a resource or its type. Instead, one or moreCRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates)ExtraService(Booking rate) records are linked to aResourceTypeto define pricing rules — each covering a specific charge period (hourly, daily, etc.) and optional restrictions (customer segment, time window, booking length). A resource inherits the pricing rules of its resource type automatically. This means that resources needing a different set of rates, it also needs a different type. You must know theResourceTypeIdbefore creating a resource.
Booking policies and restrictions
Each resource can define its own booking policies that override or extend location-level defaults:- Advance / late booking —
BookInAdvanceLimitcaps how far ahead a booking can be made;LateBookingLimitsets the minimum lead time before a booking can start. - Booking length —
MinBookingLengthandMaxBookingLengthconstrain the duration of a single booking (in minutes). - Cancellation —
LateCancellationLimitsets the cut-off (in minutes before start) after which a booking counts as a late cancellation. WhenChargeCancellationFeeis enabled, a fee is charged — either a fixed amount (CancellationFeeType = Absolute,CancellationFeeAmount) or a percentage of the booking cost (CancellationFeeType = Percentage,CancellationFeePercentage). - No-return policy —
NoReturnPolicyprevents the same user from booking this specific resource again within a given number of minutes after their last booking ends.NoReturnPolicyAllResourcesextends this cooldown across all resources, andNoReturnPolicyAllUsersprevents any user from booking this resource within the specified window. - Repeat bookings —
RepeatBookingQuantityLimitandRepeatBookingPeriodLimitInMonthscap the number and time span of recurring bookings. - Capacity —
Allocationsets the maximum number of attendees. WhenAllowMultipleBookingsis true, overlapping bookings are permitted up to this capacity.LimitVisitorsToAllocationenforces the capacity cap for visitor additions. - Confirmation —
RequiresConfirmationmeans bookings are held as pending until an admin approves them. - Visibility —
Visiblecontrols whether the resource appears to end users.Archivedhides the resource from all views.
Access restrictions
OnlyForMembers— only active members (coworkers with a plan) can book this resource.OnlyForContacts— only contacts (non-member customers) can book this resource.Tariffs— restrict bookings to coworkers on specific pricing plans.Teams— restrict bookings to members of specific teams.
Amenity flags
Boolean flags such asProjector, WhiteBoard, VideoConferencing, Soundproof, etc. describe the physical amenities available in the resource. These are used for filtering and display purposes.
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-Create role.Enums
eResourceType — SystemResourceType values
eResourceType — SystemResourceType values
eCancellationFeeType — CancellationFeeType values
eCancellationFeeType — CancellationFeeType values
Request Body
Required Fields
integer
required
ID of the business linked to this record.
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). Distinct from the custom ResourceType..
integer
required
ID of the resource type linked to this record.
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 visible and bookable by end users. Hidden resources can still be booked by admins..
boolean
When true, bookings for this resource are held as pending until an admin 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 up to the Allocation capacity..
integer
Maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity..
boolean
When true, the total number of visitors added to a booking cannot exceed the Allocation capacity..
number
Maximum number of days in advance a booking can be made for this resource. Null means no limit..
number
Minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings..
integer
Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..
integer
Minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning..
integer
Cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends..
integer
Cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window..
integer
Cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends..
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 linked to this record.
integer[]
List of teams linked to this record.
string
JSON-encoded shifts configuration defining the resource’s availability schedule..
integer[]
List of linked resources linked to this record.
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.
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..
boolean
When true, the resource is archived and hidden from all views. It cannot be booked..
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 alternative view of LinkedResources)..
boolean
When true, only contacts (non-member customers) can book this resource..
boolean
When true, only active members (coworkers with a plan) can book this resource..
boolean
When true, only coworkers invoiced by this specific location can book this resource..
integer[]
List of booking availability exceptions linked to this record.
integer
ID of the cancellation fee product linked to this record.
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 creation.
object
Contains the
Id of the newly created record.boolean
true if the resource was created 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
Create Resource