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
| Value | Name |
|---|---|
| 0 | None |
| 1 | MeetingRoom |
| 2 | HotDesk |
| 3 | PrivateOffice |
| 4 | EventSpace |
| 5 | Lab |
| 6 | Kitchen |
| 7 | TreatmentRoom |
| 9 | StorageUnit |
| 10 | Machine |
| 11 | DayPass |
| 12 | PhoneBooth |
| 99 | Other |
eCancellationFeeType — CancellationFeeType values
eCancellationFeeType — CancellationFeeType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | Absolute |
| 2 | Percentage |
Request Body
Required Fields
ID of the business linked to this record.
Display name of the resource (e.g., ‘Board Room A’, ‘Phone Booth 3’)..
Built-in resource category used for system behaviour (e.g., MeetingRoom, HotDesk, PhoneBooth). Distinct from the custom ResourceType..
ID of the resource type linked to this record.
Sort position when listing resources. Lower values appear first..
How the cancellation fee is calculated: Absolute (fixed amount) or Percentage (of booking cost)..
Optional Fields
Free-text description shown to users when viewing the resource details..
URL of a new file to upload as the picture.
Set to true to remove the current picture file.
Custom HTML or text included in booking confirmation emails for this resource..
Whether the resource is visible and bookable by end users. Hidden resources can still be booked by admins..
When true, bookings for this resource are held as pending until an admin approves them..
Optional grouping label used to cluster related resources together in the UI (e.g., ‘Floor 2’)..
Amenity flag: resource has a projector..
Amenity flag: resource has internet access..
Amenity flag: resource has a conference phone..
Amenity flag: resource has a standard phone..
Amenity flag: resource has a whiteboard..
Amenity flag: resource has a large display..
Amenity flag: catering is available for this resource..
Amenity flag: tea and coffee are available..
Amenity flag: drinks are available..
Amenity flag: resource has a security lock..
Amenity flag: resource has CCTV coverage..
Amenity flag: resource has a voice recorder..
Amenity flag: resource has air conditioning..
Amenity flag: resource has heating..
Amenity flag: resource has natural light..
Amenity flag: resource has a standing desk..
Amenity flag: resource is located in a quiet zone..
Amenity flag: resource has a wireless charger..
Amenity flag: resource has a privacy screen..
Amenity flag: resource is soundproof..
Amenity flag: resource has video conferencing equipment..
Amenity flag: resource has a dual display screen..
Amenity flag: resource has a display screen..
Amenity flag: resource has wireless presentation capabilities..
Amenity flag: resource has a PA system..
Amenity flag: resource has a desktop monitor..
Amenity flag: resource has a flip chart..
Amenity flag: resource has secure storage..
When true, overlapping bookings are permitted up to the Allocation capacity..
Maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity..
When true, the total number of visitors added to a booking cannot exceed the Allocation capacity..
Maximum number of days in advance a booking can be made for this resource. Null means no limit..
Minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings..
Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..
Minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning..
Cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends..
Cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window..
Cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends..
Maximum allowed duration for a single booking on this resource, in minutes..
Minimum allowed duration for a single booking on this resource, in minutes..
List of tariffs linked to this record.
List of teams linked to this record.
JSON-encoded shifts configuration defining the resource’s availability schedule..
List of linked resources linked to this record.
ID of the google calendar associated with this record.
ID of the kisi group associated with this record.
ID of the access control group associated with this record.
GPS longitude coordinate of the resource’s physical location..
GPS latitude coordinate of the resource’s physical location..
When true, this resource does not appear on the booking calendar view..
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..
The zoom access token value for this resource.
The zoom refresh token value for this resource.
Zoom user ID used to host virtual meetings when UseSharedZoomAccount is false..
Timestamp of the last cleaning event for this resource..
ID of the office365 calendar associated with this record.
Comma-separated string of linked resource IDs (read-only alternative view of LinkedResources)..
When true, only contacts (non-member customers) can book this resource..
When true, only active members (coworkers with a plan) can book this resource..
When true, only coworkers invoiced by this specific location can book this resource..
List of booking availability exceptions linked to this record.
ID of the cancellation fee product linked to this record.
When true, a fee is charged for late cancellations (past the LateCancellationLimit)..
Fixed cancellation fee amount. Used when CancellationFeeType is Absolute..
Cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage..
Maximum number of occurrences allowed when creating a recurring booking for this resource..
Maximum time span (in months) over which a recurring booking series can extend..
Children
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
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the resource was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Create Resource