resources
## OpenAPI
````yaml /assets/openapi.json patch /resources/v1/{id}
openapi: 3.0.2
info:
title: Spacebring
version: 1.0.0
termsOfService: https://www.spacebring.com/terms
servers:
- url: https://api.spacebring.com
security: []
paths:
/resources/v1/{id}:
patch:
tags:
- Resources
summary: Patch a resource
description: >-
Patch a certain resource. resources
operationId: patchResource
parameters:
- name: id
in: path
description: The id of the resource.
schema:
type: string
format: uuid
required: true
requestBody:
$ref: '#/components/requestBodies/patchResource'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- resources
components:
requestBodies:
patchResource:
content:
application/json:
schema:
type: object
properties:
resource:
type: object
properties:
autoRelease:
description: Auto-release settings for no-show bookings.
type: object
properties:
enabled:
type: boolean
description: Whether auto-release is enabled.
interval:
type: string
enum:
- fiveMinutes
- tenMinutes
- fifteenMinutes
description: >-
Minutes after start or creation before the slot is
released.
required:
- enabled
- interval
avigilonAltaGroupRef:
description: Avigilon Alta access group reference.
nullable: true
type: number
bookingPermission:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
description: Who can create bookings on this resource.
bookingStepMinutes:
description: Booking step size in minutes.
type: number
brivoGroupRef:
description: Brivo access group reference.
nullable: true
type: number
capacity:
description: Maximum capacity per booking.
nullable: true
type: number
checkIn:
description: Check-in settings.
type: object
properties:
interval:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
description: How early before start the guest must check in.
required:
- interval
confirmationEmail:
description: Confirmation email settings.
type: object
properties:
bookingCreatedByAdmin:
type: boolean
description: Send confirmation when an admin creates a booking.
bookingCreatedByMember:
type: boolean
description: Send confirmation when a member creates a booking.
bookingCreatedByNetworkMember:
type: boolean
description: >-
Send confirmation when a network member creates a
booking.
bookingCreatedByPublic:
type: boolean
description: >-
Send confirmation when a public user creates a
booking.
template:
type: string
description: Email template id for confirmation emails.
required:
- bookingCreatedByAdmin
- bookingCreatedByMember
- bookingCreatedByNetworkMember
- bookingCreatedByPublic
- template
credits:
description: Credit pricing settings.
type: object
properties:
enabled:
type: boolean
description: Whether customers can pay with location credits.
price:
description: Optional display price; tier data is authoritative.
type: number
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
description: Fixed fee added for this tier.
from:
type: number
description: Start of this price tier in booking minutes.
unitAmount:
type: number
description: Variable price per unit within this tier.
required:
- flatAmount
- from
- unitAmount
description: Stepped credit pricing tiers.
required:
- enabled
- tiers
dayPassesEnabled:
description: Whether day passes are enabled.
type: boolean
description:
type: string
description: Description of the resource.
duration:
description: Booking duration bounds.
type: object
properties:
max:
type: number
description: Maximum booking duration in minutes.
min:
type: number
description: Minimum booking duration in minutes.
public:
type: object
properties:
enabled:
type: boolean
description: >-
Whether public bookers have separate duration
limits.
max:
type: number
description: >-
Maximum booking duration in minutes for public
bookers.
min:
type: number
description: >-
Minimum booking duration in minutes for public
bookers.
required:
- enabled
- max
- min
description: Duration limits for public bookers.
required:
- max
- min
- public
dynamicPricing:
description: Dynamic pricing settings.
type: object
properties:
deltaAbove:
type: number
description: Maximum price increase percentage when demand is high.
deltaBelow:
type: number
description: Maximum price decrease percentage when demand is low.
enabled:
type: boolean
description: Whether dynamic pricing is enabled.
required:
- deltaAbove
- deltaBelow
- enabled
googleCalendar:
description: >-
Google Calendar integration settings. Pass null to
disconnect the calendar from the resource.
nullable: true
type: object
properties:
id:
type: string
description: Google Calendar id.
twoWaySyncEnabled:
type: boolean
description: Whether two-way sync is enabled.
required:
- id
- twoWaySyncEnabled
kisiGroupRef:
description: Kisi access group reference.
nullable: true
type: number
media:
description: Images to attach when creating the resource.
type: array
items:
type: object
properties:
key:
type: string
description: Storage key of the uploaded image.
required:
- key
money:
description: Money pricing settings.
type: object
properties:
enabled:
type: boolean
description: Whether customers can pay with money.
price:
description: Optional display price; tier data is authoritative.
type: number
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
description: Fixed fee added for this tier.
from:
type: number
description: Start of this price tier in booking minutes.
unitAmount:
type: number
description: Variable price per unit within this tier.
required:
- flatAmount
- from
- unitAmount
description: Stepped money pricing tiers.
required:
- enabled
- tiers
parentRef:
description: Parent resource id when creating a child resource.
nullable: true
type: string
format: uuid
plans:
description: Membership plan tiers sold for this resource.
type: object
properties:
enabled:
type: boolean
description: >-
Whether membership plans can be sold for this
resource.
tiers:
type: array
items:
type: object
properties:
addons:
default: []
description: Addons included in the tier.
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Addon id.
required:
- id
commitmentCycles:
type: number
description: >-
Number of billing cycles the member commits to
for this tier.
credits:
type: number
description: >-
Credits included per period in this membership
tier.
dayPasses:
description: >-
Optional number of day passes bundled with the
tier.
type: number
description:
description: Marketing or internal description of the tier.
type: string
discounts:
deprecated: true
description: Synthetic discount percentages by product type.
type: object
properties:
creditPackages:
type: number
description: Discount percentage for credit packages.
desks:
type: number
description: Discount percentage for desk bookings.
equipment:
type: number
description: Discount percentage for equipment bookings.
events:
type: number
description: Discount percentage for events.
rooms:
type: number
description: Discount percentage for room bookings.
shop:
type: number
description: Discount percentage for shop products.
entire:
type: boolean
description: >-
If true, tier grants access to the whole
resource.
ezeepBlueGroupRef:
description: Ezeep Blue printing group reference.
type: string
grantedDiscounts:
description: Coupons to grant to members on this tier.
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for amountOff.
type: string
id:
type: string
format: uuid
description: Unique identifier of the coupon.
percentOff:
description: Percentage discount.
type: number
productTypes:
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product types the coupon applies to.
required:
- id
description: Coupon to grant.
required:
- coupon
id:
type: string
format: uuid
description: Unique identifier of the tier.
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
description: Billing period label for the tier.
price:
type: number
description: >-
Recurring price for this tier in the location
currency.
selfSignupType:
description: How members may self-enroll, if applicable.
type: string
setupFee:
description: >-
One-time fee charged when subscribing to this
tier.
type: number
title:
type: string
description: Display name of the plan tier.
required:
- commitmentCycles
- credits
- entire
- id
- period
- price
- title
description: Sellable membership options for this resource.
required:
- enabled
- tiers
preparationMinutes:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
- thirtyMinutes
- sixtyMinutes
description: Buffer time blocked before each booking.
refundThreshold:
type: string
enum:
- noRefund
- zeroMinutes
- fifteenMinutes
- thirtyMinutes
- oneHour
- twoHours
- fourHours
- sixHours
- twelveHours
- oneDay
- twoDays
- oneWeek
- twoWeeks
- fourWeeks
description: How long before start a booking remains refundable.
saltoksAccessGroupRef:
description: Salto KS access group reference.
nullable: true
type: string
format: uuid
schedule:
description: Availability schedule.
type: object
properties:
default:
type: object
properties:
closedDays:
type: array
items:
type: string
description: Dates in MM-DD format when the resource is closed.
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
description: >-
Whether Friday is included in this
schedule window.
monday:
type: boolean
description: >-
Whether Monday is included in this
schedule window.
saturday:
type: boolean
description: >-
Whether Saturday is included in this
schedule window.
sunday:
type: boolean
description: >-
Whether Sunday is included in this
schedule window.
thursday:
type: boolean
description: >-
Whether Thursday is included in this
schedule window.
tuesday:
type: boolean
description: >-
Whether Tuesday is included in this
schedule window.
wednesday:
type: boolean
description: >-
Whether Wednesday is included in this
schedule window.
required:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
description: Weekdays this time window applies to.
hours:
type: object
properties:
from:
type: string
description: Opening time in 24-hour "HH:mm" format.
to:
type: string
description: Closing time in 24-hour "HH:mm" format.
required:
- from
- to
description: Open hours for the selected weekdays.
required:
- days
- hours
description: Weekly availability windows for members.
required:
- closedDays
- items
description: Default availability schedule.
enabled:
type: boolean
description: Whether scheduling is enabled.
public:
type: object
properties:
closedDays:
type: array
items:
type: string
description: >-
Dates in MM-DD format when the resource is closed
for public bookers.
enabled:
type: boolean
description: Whether the public schedule is enabled.
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
description: >-
Whether Friday is included in this
schedule window.
monday:
type: boolean
description: >-
Whether Monday is included in this
schedule window.
saturday:
type: boolean
description: >-
Whether Saturday is included in this
schedule window.
sunday:
type: boolean
description: >-
Whether Sunday is included in this
schedule window.
thursday:
type: boolean
description: >-
Whether Thursday is included in this
schedule window.
tuesday:
type: boolean
description: >-
Whether Tuesday is included in this
schedule window.
wednesday:
type: boolean
description: >-
Whether Wednesday is included in this
schedule window.
required:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
description: Weekdays this time window applies to.
hours:
type: object
properties:
from:
type: string
description: Opening time in 24-hour "HH:mm" format.
to:
type: string
description: Closing time in 24-hour "HH:mm" format.
required:
- from
- to
description: Open hours for the selected weekdays.
required:
- days
- hours
description: Weekly availability windows for public bookers.
required:
- closedDays
- enabled
- items
description: Public availability schedule.
required:
- default
- enabled
- public
tapkeyGroupRef:
description: Tapkey access group reference.
nullable: true
type: string
format: uuid
title:
type: string
minLength: 1
description: Display name of the resource.
type:
type: string
enum:
- dedicatedDesk
- equipment
- hotDesk
- office
- parkingLot
- room
- station
- conferenceRoom
- eventSpace
- meetingRoom
- phoneBooth
- studio
description: Type of the resource.
visibility:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
description: Who can see this resource in listings.
description: Resource fields to update.
required:
- resource
required: true
schemas:
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read contracts, credit notes, discounts and invoices
invoices: Read and write contract, credit notes, discounts and invoices
locations.readonly: Read locations
locations: Read and write locations
plans.readonly: Read plans
plans: Read and write plans
resources.readonly: Read resources and bookings
resources: Read and write resources and bookings
subscriptions.readonly: Read subscriptions
subscriptions: Read and write subscriptions
shop.readonly: Read products and orders
shop: Read and write products and orders
support.readonly: Read support tickets
support: Read and write support tickets
transactions.readonly: Read transactions
transactions: Read and write transactions
visitors.readonly: Read visitors
visitors: Read and write visitors
````